Thu Jul 9 13:41:42 2009

Asterisk developer's documentation


sip_peer Struct Reference

Structure for SIP peer data, we place calls to peers if registered or fixed IP address (host). More...


Data Fields

ast_mutex_t _lock
char accountcode [AST_MAX_ACCOUNT_CODE]
sockaddr_in addr
enum transfermodes allowtransfer
int amaflags
sip_authauth
int autoframing
int busy_level
sip_pvtcall
int call_limit
ast_group_t callgroup
int callingpres
int capability
ast_variablechanvars
char cid_name [80]
char cid_num [80]
ast_hacontactha
char context [AST_MAX_CONTEXT]
sockaddr_in defaddr
enum sip_transport default_outbound_transport
int deprecated_username
ast_dnsmgr_entrydnsmgr
int expire
ast_flags flags [2]
char fromdomain [MAXHOSTNAMELEN]
char fromuser [80]
char fullcontact [256]
ast_haha
char host_dynamic
int inRinging
int inUse
char is_realtime
char language [MAX_LANGUAGE]
int lastms
int lastmsgssent
struct {
   sip_mailbox *   first
   sip_mailbox *   last
mailboxes
int maxcallbitrate
int maxms
char md5secret [80]
char mohinterpret [MAX_MUSICCLASS]
char mohsuggest [MAX_MUSICCLASS]
sip_pvtmwipvt
char name [80]
sip_peernext [1]
unsigned int objflags
int onHold
sip_proxyoutboundproxy
ast_group_t pickupgroup
int pokeexpire
ast_codec_pref prefs
timeval ps
int qualifyfreq
unsigned int refcount
char regexten [AST_MAX_EXTENSION]
char rt_fromcontact
int rtpholdtimeout
int rtpkeepalive
int rtptimeout
char secret [80]
char selfdestruct
unsigned int sipoptions
sip_socket socket
sip_st_cfg stimer
char subscribecontext [AST_MAX_CONTEXT]
int timer_b
int timer_t1
char tohost [MAXHOSTNAMELEN]
unsigned int transports:3
char useragent [256]
char username [80]
char vmexten [AST_MAX_EXTENSION]


Detailed Description

Structure for SIP peer data, we place calls to peers if registered or fixed IP address (host).

Definition at line 1452 of file chan_sip.c.


Field Documentation

ast_mutex_t _lock

Definition at line 1453 of file chan_sip.c.

Referenced by update_call_counter().

char accountcode[AST_MAX_ACCOUNT_CODE]

Account code

Definition at line 1464 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), and function_sippeer().

struct sockaddr_in addr

IP address of peer

Definition at line 1508 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), expire_register(), function_sippeer(), parse_register_contact(), reg_source_db(), set_peer_defaults(), sip_addrcmp(), sip_devicestate(), sip_do_debug_peer(), sip_poke_peer(), sip_send_mwi_to_peer(), and update_peer().

enum transfermodes allowtransfer

Definition at line 1479 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), and set_peer_defaults().

int amaflags

AMA Flags (for billing)

Definition at line 1465 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), and check_peer_ok().

struct sip_auth* auth

Realm authentication list

Definition at line 1460 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), and sip_destroy_peer().

int autoframing

Definition at line 1523 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), register_verify(), and set_peer_defaults().

int busy_level

Level of active channels where we signal busy

Definition at line 1478 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), function_sippeer(), and sip_devicestate().

struct sip_pvt* call

Call pointer

Definition at line 1512 of file chan_sip.c.

Referenced by handle_response_peerpoke(), sip_destroy_peer(), sip_poke_noanswer(), and sip_poke_peer().

int call_limit

Limit of concurrent calls

Definition at line 1477 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), function_sippeer(), set_peer_defaults(), sip_devicestate(), and update_call_counter().

ast_group_t callgroup

Call group

Definition at line 1504 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), function_sippeer(), and set_peer_defaults().

int callingpres

Calling id presentation

Definition at line 1473 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), and check_peer_ok().

int capability

Codec capability

Definition at line 1500 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), function_sippeer(), and set_peer_defaults().

struct ast_variable* chanvars

Variables to set for channel created by user

Definition at line 1521 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), function_sippeer(), and sip_destroy_peer().

char cid_name[80]

Caller ID name

Definition at line 1472 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), function_sippeer(), and set_peer_defaults().

char cid_num[80]

Caller ID num

Definition at line 1471 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), function_sippeer(), and set_peer_defaults().

struct ast_ha* contactha

Restrict what IPs are allowed in the Contact header (for registration)

Definition at line 1520 of file chan_sip.c.

Referenced by build_peer(), and parse_register_contact().

char context[AST_MAX_CONTEXT]

Default context for incoming calls

Definition at line 1461 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), function_sippeer(), and set_peer_defaults().

struct sockaddr_in defaddr

Default IP address, used until registration

Definition at line 1518 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), set_peer_defaults(), sip_devicestate(), and sip_send_mwi_to_peer().

enum sip_transport default_outbound_transport

Peer Registration may change the default outbound transport.

Definition at line 1456 of file chan_sip.c.

Referenced by build_peer(), expire_register(), and parse_register_contact().

int deprecated_username

If it's a realtime peer, are they using the deprecated "username" instead of "defaultuser"

Definition at line 1527 of file chan_sip.c.

Referenced by build_peer(), destroy_association(), and update_peer().

struct ast_dnsmgr_entry* dnsmgr

DNS refresh manager for peer

Definition at line 1507 of file chan_sip.c.

Referenced by sip_destroy_peer().

int expire

When to expire this peer registration

Definition at line 1499 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), expire_register(), function_sippeer(), parse_register_contact(), reg_source_db(), set_peer_defaults(), sip_destroy_peer(), and sip_unregister().

struct sip_mailbox* first

Definition at line 1491 of file chan_sip.c.

struct ast_flags flags[2]

SIP_ flags

Definition at line 1488 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), expire_register(), handle_request_subscribe(), parse_register_contact(), register_verify(), set_peer_defaults(), sip_addrcmp(), sip_poke_peer(), sip_send_mwi_to_peer(), and update_peer().

char fromdomain[MAXHOSTNAMELEN]

From: domain when calling this peer

Definition at line 1469 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), and set_peer_defaults().

char fromuser[80]

From: user when calling this peer

Definition at line 1468 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), and set_peer_defaults().

char fullcontact[256]

Contact registered with us (not in sip.conf)

Definition at line 1470 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), parse_register_contact(), reg_source_db(), sip_poke_peer(), and update_peer().

struct ast_ha* ha

Access control list

Definition at line 1519 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), register_verify(), and sip_destroy_peer().

char host_dynamic

P: Dynamic Peers register with Asterisk

Definition at line 1496 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), function_sippeer(), and register_verify().

int inRinging

Number of calls ringing

Definition at line 1475 of file chan_sip.c.

Referenced by sip_devicestate(), and update_call_counter().

int inUse

Number of calls in use

Definition at line 1474 of file chan_sip.c.

Referenced by function_sippeer(), sip_devicestate(), and update_call_counter().

char is_realtime

this is a 'realtime' peer

Definition at line 1494 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), expire_register(), parse_register_contact(), sip_destroy_peer(), and update_peer().

char language[MAX_LANGUAGE]

Default language for prompts

Definition at line 1481 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), function_sippeer(), and set_peer_defaults().

struct sip_mailbox* last

Definition at line 1491 of file chan_sip.c.

int lastms

How long last response took (in ms), or -1 for no response

Definition at line 1514 of file chan_sip.c.

Referenced by build_peer(), check_peer_ok(), create_addr_from_peer(), handle_response_peerpoke(), parse_register_contact(), peer_status(), sip_devicestate(), sip_poke_noanswer(), sip_poke_peer(), and update_peer().

int lastmsgssent

Definition at line 1486 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), and register_verify().

struct { ... } mailboxes

Mailboxes that this peer cares about

Referenced by add_peer_mailboxes(), add_peer_mwi_subs(), build_peer(), clear_peer_mailboxes(), get_cached_mwi(), handle_request_subscribe(), and peer_mailboxes_to_str().

int maxcallbitrate

Maximum Bitrate for a video call

Definition at line 1509 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), and set_peer_defaults().

int maxms

Max ms we will accept for the host to be up, 0 to not monitor

Definition at line 1515 of file chan_sip.c.

Referenced by build_peer(), check_peer_ok(), create_addr_from_peer(), handle_response_peerpoke(), peer_status(), set_peer_defaults(), sip_devicestate(), and sip_poke_peer().

char md5secret[80]

Password in MD5

Definition at line 1459 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), register_verify(), and set_peer_defaults().

char mohinterpret[MAX_MUSICCLASS]

Music on Hold class

Definition at line 1482 of file chan_sip.c.

Referenced by build_peer(), check_peer_ok(), create_addr_from_peer(), and set_peer_defaults().

char mohsuggest[MAX_MUSICCLASS]

Music on Hold class

Definition at line 1483 of file chan_sip.c.

Referenced by build_peer(), check_peer_ok(), create_addr_from_peer(), and set_peer_defaults().

struct sip_pvt* mwipvt

Subscription for MWI

Definition at line 1522 of file chan_sip.c.

Referenced by __sip_destroy(), handle_request_subscribe(), sip_destroy_peer(), and sip_send_mwi_to_peer().

char name[80]

Definition at line 1453 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), destroy_association(), expire_register(), handle_request_subscribe(), handle_response_peerpoke(), parse_register_contact(), reg_source_db(), register_peer_exten(), register_verify(), sip_destroy_peer(), sip_peer_hold(), sip_poke_noanswer(), update_call_counter(), and update_peer().

struct sip_peer* next[1]

Definition at line 1453 of file chan_sip.c.

Referenced by add_peer_mailboxes().

unsigned int objflags

Definition at line 1453 of file chan_sip.c.

Referenced by build_peer().

int onHold

Peer has someone on hold

Definition at line 1476 of file chan_sip.c.

Referenced by sip_devicestate(), and sip_peer_hold().

struct sip_proxy* outboundproxy

Outbound proxy for this peer

Definition at line 1506 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), obproxy_get(), and sip_destroy_peer().

ast_group_t pickupgroup

Pickup group

Definition at line 1505 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), function_sippeer(), and set_peer_defaults().

int pokeexpire

When to expire poke (qualify= checking)

Definition at line 1513 of file chan_sip.c.

Referenced by handle_response_peerpoke(), reg_source_db(), set_peer_defaults(), sip_destroy_peer(), sip_poke_noanswer(), sip_poke_peer(), and sip_poke_peer_s().

struct ast_codec_pref prefs

codec prefs

Definition at line 1485 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), function_sippeer(), register_verify(), and set_peer_defaults().

struct timeval ps

Time for sending SIP OPTION in sip_pke_peer()

Definition at line 1517 of file chan_sip.c.

Referenced by handle_response_peerpoke(), and sip_poke_peer().

int qualifyfreq

Qualification: How often to check for the host to be up

Definition at line 1516 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), handle_response_peerpoke(), and set_peer_defaults().

unsigned int refcount

Definition at line 1453 of file chan_sip.c.

char regexten[AST_MAX_EXTENSION]

Extension to register (if regcontext is used)

Definition at line 1467 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), function_sippeer(), register_peer_exten(), and set_peer_defaults().

char rt_fromcontact

P: copy fromcontact from realtime

Definition at line 1495 of file chan_sip.c.

Referenced by build_peer(), destroy_association(), parse_register_contact(), and reg_source_db().

int rtpholdtimeout

RTP Hold Timeout

Definition at line 1502 of file chan_sip.c.

Referenced by build_peer(), create_addr_from_peer(), and set_peer_defaults().

int rtpkeepalive

Send RTP packets for keepalive

Definition at line 1503 of file chan_sip.c.

Referenced by build_peer(), create_addr_from_peer(), and set_peer_defaults().

int rtptimeout

RTP timeout

Definition at line 1501 of file chan_sip.c.

Referenced by build_peer(), create_addr_from_peer(), and set_peer_defaults().

char secret[80]

Password

Definition at line 1458 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), register_verify(), and set_peer_defaults().

char selfdestruct

P: Automatic peers need to destruct themselves

Definition at line 1497 of file chan_sip.c.

Referenced by expire_register(), and sip_destroy_peer().

unsigned int sipoptions

Supported SIP options

Definition at line 1487 of file chan_sip.c.

Referenced by _sip_show_peer(), check_peer_ok(), and parse_register_contact().

struct sip_socket socket

name, refcount, objflags, object pointers peer->name is the unique name of this object Socket used for this peer

Definition at line 1455 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), expire_register(), parse_register_contact(), set_peer_defaults(), sip_destroy_peer(), and sip_poke_peer().

struct sip_st_cfg stimer

SIP Session-Timers

Definition at line 1524 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), and set_peer_defaults().

char subscribecontext[AST_MAX_CONTEXT]

Default context for subscriptions

Definition at line 1462 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), and set_peer_defaults().

int timer_b

The maximum timer B (transaction timeouts)

Definition at line 1526 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), and set_peer_defaults().

int timer_t1

The maximum T1 value for the peer

Definition at line 1525 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), and set_peer_defaults().

char tohost[MAXHOSTNAMELEN]

If not dynamic, IP address

Definition at line 1466 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), create_addr_from_peer(), and sip_poke_peer().

unsigned int transports

Transports (enum sip_transport) that are acceptable for this peer

Definition at line 1457 of file chan_sip.c.

Referenced by build_peer(), get_transport_list(), and parse_register_contact().

char useragent[256]

User agent in SIP request (saved from registration)

Definition at line 1484 of file chan_sip.c.

Referenced by _sip_show_peer(), function_sippeer(), and parse_register_contact().

char username[80]

Temporary username until registration

Definition at line 1463 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_peer_ok(), create_addr_from_peer(), parse_register_contact(), reg_source_db(), and update_peer().

char vmexten[AST_MAX_EXTENSION]

SIP Refer restriction scheme Dialplan extension for MWI notify message

Definition at line 1480 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), set_peer_defaults(), and sip_send_mwi_to_peer().


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