Asterisk - The Open Source Telephony Project GIT-master-f36a736
Data Fields
sip_outbound_registration_client_state Struct Reference

Outbound registration client state information (persists for lifetime of regc) More...

Collaboration diagram for sip_outbound_registration_client_state:
Collaboration graph
[legend]

Data Fields

unsigned int auth_attempted:1
 Non-zero if we have attempted sending a REGISTER with authentication. More...
 
unsigned int auth_cseq
 
unsigned int auth_rejection_permanent
 Treat authentication challenges that we cannot handle as permanent failures. More...
 
pjsip_regc * client
 Outbound registration client. More...
 
unsigned int destroy:1
 Registration should be destroyed after completion of transaction. More...
 
unsigned int fatal_retry_interval
 Interval at which retries should occur for all permanent responses. More...
 
unsigned int forbidden_retry_interval
 Interval at which retries should occur for permanent responses. More...
 
int last_status_code
 Status code of last response if we have tried to register before. More...
 
pjsip_tx_data * last_tdata
 Last tdata sent We need the original tdata to resend a request on auth failure or timeout. On an auth failure, we use the original tdata to initialize the new tdata for the authorized response. On a timeout we need it to skip failed SRV entries if any. More...
 
char line [LINE_PARAMETER_SIZE]
 Optional line parameter placed into Contact. More...
 
unsigned int max_retries
 Maximum number of retries permitted. More...
 
struct ast_sip_auth_vector outbound_auths
 Configured authentication credentials. More...
 
unsigned int registration_expires
 Expected time of registration lapse/expiration. More...
 
char * registration_name
 The name of the registration sorcery object. More...
 
unsigned int retries
 Current number of retries. More...
 
unsigned int retry_interval
 Interval at which retries should occur for temporal responses. More...
 
struct ast_sip_security_mechanism_vector security_mechanisms
 Client security mechanisms (RFC 3329). More...
 
enum ast_sip_security_negotiation security_negotiation
 Type of security negotiation to use (RFC 3329). More...
 
struct ast_taskprocessorserializer
 Serializer for stuff and things. More...
 
struct ast_sip_security_mechanism_vector server_security_mechanisms
 Security mechanisms of the peer (RFC 3329). More...
 
enum sip_outbound_registration_status status
 Current state of this registration. More...
 
unsigned int support_outbound
 Determines whether SIP Outbound support should be advertised. More...
 
unsigned int support_path
 Determines whether SIP Path support should be advertised. More...
 
pj_timer_entry timer
 Timer entry for retrying on temporal responses. More...
 
char * transport_name
 The name of the transport to be used for the registration. More...
 
char * user_agent
 The value for the User-Agent header sent in requests. More...
 

Detailed Description

Outbound registration client state information (persists for lifetime of regc)

Definition at line 379 of file res_pjsip_outbound_registration.c.

Field Documentation

◆ auth_attempted

unsigned int auth_attempted

Non-zero if we have attempted sending a REGISTER with authentication.

Definition at line 432 of file res_pjsip_outbound_registration.c.

Referenced by add_security_headers(), and handle_registration_response().

◆ auth_cseq

unsigned int auth_cseq

CSeq number of last sent auth request.

Definition at line 424 of file res_pjsip_outbound_registration.c.

Referenced by handle_registration_response().

◆ auth_rejection_permanent

unsigned int auth_rejection_permanent

Treat authentication challenges that we cannot handle as permanent failures.

Definition at line 412 of file res_pjsip_outbound_registration.c.

Referenced by sip_outbound_registration_is_temporal().

◆ client

pjsip_regc* client

Outbound registration client.

Note
May only be accessed within the serializer thread because it might get destroyed and set to NULL for module unload.

Definition at line 388 of file res_pjsip_outbound_registration.c.

Referenced by handle_client_state_destruction(), handle_registration_response(), registration_client_send(), and schedule_registration().

◆ destroy

unsigned int destroy

Registration should be destroyed after completion of transaction.

Definition at line 430 of file res_pjsip_outbound_registration.c.

Referenced by handle_client_state_destruction(), and handle_registration_response().

◆ fatal_retry_interval

unsigned int fatal_retry_interval

Interval at which retries should occur for all permanent responses.

Definition at line 410 of file res_pjsip_outbound_registration.c.

Referenced by handle_registration_response().

◆ forbidden_retry_interval

unsigned int forbidden_retry_interval

Interval at which retries should occur for permanent responses.

Definition at line 408 of file res_pjsip_outbound_registration.c.

Referenced by handle_registration_response().

◆ last_status_code

int last_status_code

Status code of last response if we have tried to register before.

Definition at line 434 of file res_pjsip_outbound_registration.c.

Referenced by add_security_headers(), and handle_registration_response().

◆ last_tdata

pjsip_tx_data* last_tdata

Last tdata sent We need the original tdata to resend a request on auth failure or timeout. On an auth failure, we use the original tdata to initialize the new tdata for the authorized response. On a timeout we need it to skip failed SRV entries if any.

Definition at line 396 of file res_pjsip_outbound_registration.c.

Referenced by registration_client_send(), sip_outbound_registration_client_state_destroy(), and sip_outbound_registration_response_cb().

◆ line

char line[LINE_PARAMETER_SIZE]

Optional line parameter placed into Contact.

Definition at line 400 of file res_pjsip_outbound_registration.c.

◆ max_retries

unsigned int max_retries

Maximum number of retries permitted.

Definition at line 404 of file res_pjsip_outbound_registration.c.

Referenced by handle_registration_response().

◆ outbound_auths

struct ast_sip_auth_vector outbound_auths

Configured authentication credentials.

Definition at line 428 of file res_pjsip_outbound_registration.c.

Referenced by handle_client_state_destruction(), and handle_registration_response().

◆ registration_expires

unsigned int registration_expires

Expected time of registration lapse/expiration.

Definition at line 440 of file res_pjsip_outbound_registration.c.

Referenced by schedule_registration().

◆ registration_name

char* registration_name

◆ retries

unsigned int retries

Current number of retries.

Definition at line 402 of file res_pjsip_outbound_registration.c.

Referenced by handle_registration_response().

◆ retry_interval

unsigned int retry_interval

Interval at which retries should occur for temporal responses.

Definition at line 406 of file res_pjsip_outbound_registration.c.

Referenced by handle_registration_response(), and Registration::write().

◆ security_mechanisms

struct ast_sip_security_mechanism_vector security_mechanisms

Client security mechanisms (RFC 3329).

Definition at line 420 of file res_pjsip_outbound_registration.c.

Referenced by add_security_headers(), and handle_client_state_destruction().

◆ security_negotiation

enum ast_sip_security_negotiation security_negotiation

Type of security negotiation to use (RFC 3329).

Definition at line 418 of file res_pjsip_outbound_registration.c.

Referenced by add_security_headers(), and handle_registration_response().

◆ serializer

◆ server_security_mechanisms

struct ast_sip_security_mechanism_vector server_security_mechanisms

Security mechanisms of the peer (RFC 3329).

Definition at line 422 of file res_pjsip_outbound_registration.c.

Referenced by add_security_headers(), handle_client_state_destruction(), and handle_registration_response().

◆ status

◆ support_outbound

unsigned int support_outbound

Determines whether SIP Outbound support should be advertised.

Definition at line 416 of file res_pjsip_outbound_registration.c.

Referenced by add_configured_supported_headers().

◆ support_path

unsigned int support_path

Determines whether SIP Path support should be advertised.

Definition at line 414 of file res_pjsip_outbound_registration.c.

Referenced by add_configured_supported_headers().

◆ timer

pj_timer_entry timer

Timer entry for retrying on temporal responses.

Definition at line 398 of file res_pjsip_outbound_registration.c.

Referenced by cancel_registration(), and schedule_registration().

◆ transport_name

char* transport_name

The name of the transport to be used for the registration.

Definition at line 436 of file res_pjsip_outbound_registration.c.

Referenced by registration_client_send(), save_response_fields_to_transport(), and sip_outbound_registration_client_state_destroy().

◆ user_agent

char* user_agent

The value for the User-Agent header sent in requests.

Definition at line 442 of file res_pjsip_outbound_registration.c.

Referenced by registration_client_send(), and sip_outbound_registration_client_state_destroy().


The documentation for this struct was generated from the following file: