Thu Apr 28 2011 16:57:21

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...

Collaboration diagram for sip_peer:

Data Fields

struct ast_string_field_mgr __field_mgr
struct ast_string_field_pool__field_mgr_pool
const ast_string_field accountcode
struct sockaddr_in addr
enum transfermodes allowtransfer
int amaflags
struct sip_authauth
int autoframing
int busy_level
struct sip_pvtcall
int call_limit
ast_group_t callgroup
int callingpres
int capability
struct ast_variablechanvars
const ast_string_field cid_name
const ast_string_field cid_num
struct ast_hacontactha
const ast_string_field context
struct sockaddr_in defaddr
enum sip_transport default_outbound_transport
int deprecated_username
struct ast_dnsmgr_entrydnsmgr
int expire
struct ast_flags flags [2]
const ast_string_field fromdomain
const ast_string_field fromuser
const ast_string_field fullcontact
struct ast_haha
char host_dynamic
int inRinging
int inUse
char is_realtime
const ast_string_field language
int lastms
int lastmsgssent
struct {
   struct sip_mailbox *   first
   struct sip_mailbox *   last
mailboxes
int maxcallbitrate
int maxms
const ast_string_field md5secret
const ast_string_field mohinterpret
const ast_string_field mohsuggest
struct sip_pvtmwipvt
char name [80]
int onHold
struct sip_proxyoutboundproxy
const ast_string_field parkinglot
ast_group_t pickupgroup
int pokeexpire
unsigned int portinuri:1
struct ast_codec_pref prefs
struct timeval ps
int qualifyfreq
const ast_string_field regexten
const ast_string_field remotesecret
char rt_fromcontact
int rtpholdtimeout
int rtpkeepalive
int rtptimeout
const ast_string_field secret
char selfdestruct
unsigned int sipoptions
struct sip_socket socket
struct sip_st_cfg stimer
const ast_string_field subscribecontext
int t38_maxdatagram
char the_mark
int timer_b
int timer_t1
const ast_string_field tohost
unsigned int transports:3
enum sip_peer_type type
const ast_string_field useragent
const ast_string_field username
const ast_string_field vmexten

Detailed Description

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

Definition at line 1838 of file chan_sip.c.


Field Documentation

Definition at line 1861 of file chan_sip.c.

Definition at line 1861 of file chan_sip.c.

int amaflags

AMA Flags (for billing)

Definition at line 1867 of file chan_sip.c.

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

struct sip_auth* auth

Realm authentication list

Definition at line 1866 of file chan_sip.c.

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

Level of active channels where we signal busy

Definition at line 1874 of file chan_sip.c.

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

Calling id presentation

Definition at line 1868 of file chan_sip.c.

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

Variables to set for channel created by user

Definition at line 1914 of file chan_sip.c.

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

struct ast_ha* contactha

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

Definition at line 1913 of file chan_sip.c.

Referenced by build_peer(), and parse_register_contact().

struct sockaddr_in defaddr

Default IP address, used until registration

Definition at line 1911 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().

Peer Registration may change the default outbound transport. If register expires, default should be reset. to this value

Definition at line 1863 of file chan_sip.c.

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

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

Definition at line 1920 of file chan_sip.c.

Referenced by build_peer(), and update_peer().

DNS refresh manager for peer

Definition at line 1899 of file chan_sip.c.

Referenced by build_peer(), and sip_destroy_peer().

struct sip_mailbox* first

Definition at line 1882 of file chan_sip.c.

Dynamic Peers register with Asterisk

Definition at line 1887 of file chan_sip.c.

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

int inRinging

Number of calls ringing

Definition at line 1870 of file chan_sip.c.

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

int inUse

Number of calls in use

Definition at line 1869 of file chan_sip.c.

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

struct sip_mailbox* last

Definition at line 1882 of file chan_sip.c.

int lastms

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

Definition at line 1907 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().

Definition at line 1877 of file chan_sip.c.

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

Maximum Bitrate for a video call

Definition at line 1901 of file chan_sip.c.

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

int maxms

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

Definition at line 1908 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().

Definition at line 1861 of file chan_sip.c.

Referenced by check_peer_ok(), and create_addr_from_peer().

Definition at line 1861 of file chan_sip.c.

Referenced by check_peer_ok(), and create_addr_from_peer().

struct sip_pvt* mwipvt

Subscription for MWI

Definition at line 1915 of file chan_sip.c.

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

char name[80]

the unique name of this object Password for inbound auth Password in MD5 Remote secret (trunks, remote devices) Default context for incoming calls Default context for subscriptions Temporary username until registration Account code If not dynamic, IP address Extension to register (if regcontext is used) From: user when calling this peer From: domain when calling this peer Contact registered with us (not in sip.conf) Caller ID num Caller ID name Dialplan extension for MWI notify message Default language for prompts Music on Hold class Music on Hold class Parkinglot User agent in SIP request (saved from registration)

Definition at line 1839 of file chan_sip.c.

Referenced by _sip_show_peer(), _sip_show_peers(), build_peer(), check_peer_ok(), complete_sip_peer(), complete_sip_registered_peer(), complete_sip_user(), create_addr_from_peer(), destroy_association(), expire_register(), find_by_name(), find_peer(), handle_request_subscribe(), handle_response_peerpoke(), parse_register_contact(), peer_cmp_cb(), peer_dump_func(), peer_hash_cb(), realtime_peer(), reg_source_db(), register_peer_exten(), register_verify(), sip_destroy_peer(), sip_peer_hold(), sip_poke_noanswer(), sip_poke_peer_s(), sip_prune_realtime(), sip_show_inuse(), sip_show_user(), sip_show_users(), temp_peer(), update_call_counter(), and update_peer().

int onHold

Peer has someone on hold

Definition at line 1871 of file chan_sip.c.

Referenced by sip_devicestate(), sip_peer_hold(), and sip_show_inuse().

Outbound proxy for this peer

Definition at line 1898 of file chan_sip.c.

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

Definition at line 1861 of file chan_sip.c.

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

unsigned int portinuri

Whether the port should be included in the URI

Definition at line 1902 of file chan_sip.c.

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

struct timeval ps

Time for sending SIP OPTION in sip_pke_peer()

Definition at line 1910 of file chan_sip.c.

Referenced by handle_response_peerpoke(), and sip_poke_peer().

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

Definition at line 1909 of file chan_sip.c.

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

Definition at line 1861 of file chan_sip.c.

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

Definition at line 1861 of file chan_sip.c.

Referenced by _sip_show_peer(), and build_peer().

copy fromcontact from realtime

Definition at line 1886 of file chan_sip.c.

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

RTP Hold Timeout

Definition at line 1894 of file chan_sip.c.

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

Send RTP packets for keepalive

Definition at line 1895 of file chan_sip.c.

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

RTP timeout

Definition at line 1893 of file chan_sip.c.

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

Automatic peers need to destruct themselves

Definition at line 1888 of file chan_sip.c.

Referenced by expire_register(), sip_destroy_peer(), and temp_peer().

unsigned int sipoptions

Supported SIP options

Definition at line 1878 of file chan_sip.c.

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

SIP Session-Timers

Definition at line 1917 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), set_peer_defaults(), sip_show_user(), st_get_mode(), st_get_refresher(), and st_get_se().

Definition at line 1861 of file chan_sip.c.

Referenced by _sip_show_peer(), and check_peer_ok().

T.38 FaxMaxDatagram override

Definition at line 1873 of file chan_sip.c.

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

char the_mark

moved out of ASTOBJ into struct proper; That which bears the_mark should be deleted!

Definition at line 1889 of file chan_sip.c.

Referenced by build_peer(), peer_is_marked(), peer_markall_func(), and sip_prune_realtime().

int timer_b

The maximum timer B (transaction timeouts)

Definition at line 1919 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 1918 of file chan_sip.c.

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

unsigned int transports

Transports (enum sip_transport) that are acceptable for this peer

Definition at line 1865 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), find_peer(), parse_register_contact(), peer_ipcmp_cb(), and set_peer_defaults().

Distinguish between "user" and "peer" types. This is used solely for CLI and manager commands

Definition at line 1923 of file chan_sip.c.

Referenced by _sip_show_peers(), build_peer(), complete_sip_user(), find_by_name(), find_peer(), reload_config(), set_peer_defaults(), and sip_show_users().

Definition at line 1861 of file chan_sip.c.

Referenced by _sip_show_peer(), and sip_send_mwi_to_peer().


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