Thu Jul 9 13:41:42 2009

Asterisk developer's documentation

sip_registry Struct Reference

Registrations with other SIP proxies Created by sip_register(), the entry is linked in the 'regl' list, and never deleted (other than at 'sip reload' or module unload times). The entry always has a pending timeout, either waiting for an ACK to the REGISTER message (in which case we have to retransmit the request), or waiting for the next REGISTER message to be sent (either the initial one, or once the previously completed registration one expires). The registration can be in one of many states, though at the moment the handling is a bit mixed. Note that the entire evolution of sip_registry (transmissions, incoming packets and timeouts) is driven by one single thread, do_monitor(), so there is almost no synchronization issue. The only exception is the sip_pvt creation/lookup, as the dialoglist is also manipulated by other threads. More...


Data Fields

ast_string_field_mgr __field_mgr
ast_string_field_pool * __field_mgr_pool
ast_mutex_t _lock
const ast_string_field authuser
sip_pvt * call
const ast_string_field callback
const ast_string_field callid
int callid_valid
const ast_string_field domain
int expire
int expiry
const ast_string_field hostname
char lastmsg [256]
const ast_string_field md5secret
char name [1]
sip_registry * next [1]
const ast_string_field nonce
int noncecount
unsigned int objflags
unsigned int ocseq
const ast_string_field opaque
int portno
const ast_string_field qop
const ast_string_field random
const ast_string_field realm
unsigned int refcount
int refresh
int regattempts
enum sipregistrystate regstate
timeval regtime
const ast_string_field secret
int timeout
enum sip_transport transport
sockaddr_in us
const ast_string_field username

Detailed Description

Registrations with other SIP proxies Created by sip_register(), the entry is linked in the 'regl' list, and never deleted (other than at 'sip reload' or module unload times). The entry always has a pending timeout, either waiting for an ACK to the REGISTER message (in which case we have to retransmit the request), or waiting for the next REGISTER message to be sent (either the initial one, or once the previously completed registration one expires). The registration can be in one of many states, though at the moment the handling is a bit mixed. Note that the entire evolution of sip_registry (transmissions, incoming packets and timeouts) is driven by one single thread, do_monitor(), so there is almost no synchronization issue. The only exception is the sip_pvt creation/lookup, as the dialoglist is also manipulated by other threads.

Definition at line 1546 of file chan_sip.c.

Field Documentation

struct ast_string_field_mgr __field_mgr

Definition at line 1562 of file chan_sip.c.

struct ast_string_field_pool* __field_mgr_pool

Global Call-ID Authorization realm Authorization nonce Opaque nonsense Quality of Protection, since SIP wasn't complicated enough yet. Authorization domain Who we are registering as Who we *authenticate* as Domain or host we register to Password in clear text Password in md5 Contact extension

Definition at line 1562 of file chan_sip.c.

ast_mutex_t _lock

Definition at line 1547 of file chan_sip.c.

const ast_string_field authuser

Definition at line 1562 of file chan_sip.c.

Referenced by sip_register(), and transmit_register().

struct sip_pvt* call

create a sip_pvt structure for each outbound "registration dialog" in progress

Definition at line 1570 of file chan_sip.c.

Referenced by handle_response_register(), sip_reg_timeout(), sip_registry_destroy(), sip_reregister(), and transmit_register().

const ast_string_field callback

Definition at line 1562 of file chan_sip.c.

Referenced by sip_register(), and transmit_register().

const ast_string_field callid

Definition at line 1562 of file chan_sip.c.

Referenced by transmit_register().

int callid_valid

0 means we haven't chosen callid for this registry yet.

Definition at line 1573 of file chan_sip.c.

Referenced by transmit_register().

const ast_string_field domain

Definition at line 1562 of file chan_sip.c.

Referenced by transmit_register().

int expire

Sched ID of expiration

Definition at line 1565 of file chan_sip.c.

Referenced by handle_response_register(), sip_registry_destroy(), and sip_reregister().

int expiry

Value to use for the Expires header

Definition at line 1566 of file chan_sip.c.

Referenced by handle_response_register(), and transmit_register().

const ast_string_field hostname

Definition at line 1562 of file chan_sip.c.

Referenced by do_register_auth(), handle_response_register(), registry_addref(), registry_unref(), sip_reg_timeout(), sip_registry_destroy(), sip_reregister(), and transmit_register().

char lastmsg[256]

Last Message sent/received

Definition at line 1577 of file chan_sip.c.

const ast_string_field md5secret

Definition at line 1562 of file chan_sip.c.

Referenced by transmit_register().

char name[1]

Definition at line 1547 of file chan_sip.c.

struct sip_registry* next[1]

Definition at line 1547 of file chan_sip.c.

const ast_string_field nonce

Definition at line 1562 of file chan_sip.c.

Referenced by reply_digest(), and transmit_register().

int noncecount

Nonce-count

Definition at line 1576 of file chan_sip.c.

Referenced by reply_digest(), and transmit_register().

unsigned int objflags

Definition at line 1547 of file chan_sip.c.

unsigned int ocseq

Sequence number we got to for REGISTERs for this registry

Definition at line 1574 of file chan_sip.c.

Referenced by transmit_register().

const ast_string_field opaque

Definition at line 1562 of file chan_sip.c.

Referenced by build_reply_digest(), reply_digest(), and transmit_register().

int portno

Optional port override

Definition at line 1564 of file chan_sip.c.

Referenced by transmit_register().

const ast_string_field qop

Definition at line 1562 of file chan_sip.c.

Referenced by reply_digest(), and transmit_register().

const ast_string_field random

Definition at line 1562 of file chan_sip.c.

const ast_string_field realm

Definition at line 1562 of file chan_sip.c.

Referenced by reply_digest(), and transmit_register().

unsigned int refcount

Definition at line 1547 of file chan_sip.c.

Referenced by registry_addref(), and registry_unref().

int refresh

How often to refresh

Definition at line 1569 of file chan_sip.c.

Referenced by handle_response_register().

int regattempts

Number of attempts (since the last success)

Definition at line 1567 of file chan_sip.c.

Referenced by handle_response_register(), sip_reg_timeout(), and transmit_register().

enum sipregistrystate regstate

Registration state (see above)

Definition at line 1571 of file chan_sip.c.

Referenced by handle_response_register(), sip_reg_timeout(), and transmit_register().

struct timeval regtime

Last successful registration time

Definition at line 1572 of file chan_sip.c.

Referenced by handle_response_register().

const ast_string_field secret

Definition at line 1562 of file chan_sip.c.

Referenced by transmit_register().

int timeout

sched id of sip_reg_timeout

Definition at line 1568 of file chan_sip.c.

Referenced by handle_response_register(), sip_reg_timeout(), sip_registry_destroy(), and transmit_register().

enum sip_transport transport

Definition at line 1563 of file chan_sip.c.

Referenced by sip_register(), and transmit_register().

struct sockaddr_in us

Who the server thinks we are

Definition at line 1575 of file chan_sip.c.

const ast_string_field username

Definition at line 1562 of file chan_sip.c.

Referenced by handle_response_register(), sip_reg_timeout(), sip_registry_destroy(), sip_reregister(), and transmit_register().

The documentation for this struct was generated from the following file:
Generated on Thu Jul 9 13:41:42 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7