Sat Aug 6 00:40:09 2011

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
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
int expire
ast_flags flags [2]
char fromdomain [MAXHOSTNAMELEN]
char fromuser [80]
char fullcontact [256]
ast_haha
int inRinging
int inUse
char language [MAX_LANGUAGE]
int lastms
int lastmsg
time_t lastmsgcheck
int lastmsgssent
char mailbox [AST_MAX_EXTENSION]
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
ast_group_t pickupgroup
int pokeexpire
unsigned int portinuri:1
ast_codec_pref prefs
timeval ps
unsigned int refcount
char regexten [AST_MAX_EXTENSION]
int rtpholdtimeout
int rtpkeepalive
int rtptimeout
char secret [80]
unsigned int sipoptions
char subscribecontext [AST_MAX_CONTEXT]
char tohost [MAXHOSTNAMELEN]
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 1144 of file chan_sip.c.


Field Documentation

ast_mutex_t _lock

Definition at line 1145 of file chan_sip.c.

char accountcode[AST_MAX_ACCOUNT_CODE]

Account code

Definition at line 1153 of file chan_sip.c.

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

struct sockaddr_in addr

IP address of peer

Definition at line 1186 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 1167 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 1154 of file chan_sip.c.

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

struct sip_auth* auth

Realm authentication list

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

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

struct sip_pvt* call

Call pointer

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

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

ast_group_t callgroup

Call group

Definition at line 1184 of file chan_sip.c.

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

int callingpres

Calling id presentation

Definition at line 1162 of file chan_sip.c.

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

int capability

Codec capability

Definition at line 1180 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_user_full(), 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 1200 of file chan_sip.c.

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

char cid_name[80]

Caller ID name

Definition at line 1161 of file chan_sip.c.

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

char cid_num[80]

Caller ID num

Definition at line 1160 of file chan_sip.c.

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

struct ast_ha* contactha

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

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

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

struct sockaddr_in defaddr

Default IP address, used until registration

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

int expire

When to expire this peer registration

Definition at line 1179 of file chan_sip.c.

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

struct ast_flags flags[2]

SIP_ flags

Definition at line 1178 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_user_full(), create_addr_from_peer(), destroy_association(), does_peer_need_mwi(), expire_register(), function_sippeer(), parse_register_contact(), reg_source_db(), register_verify(), set_peer_defaults(), sip_addrcmp(), sip_destroy_peer(), sip_poke_peer(), update_call_counter(), and update_peer().

char fromdomain[MAXHOSTNAMELEN]

From: domain when calling this peer

Definition at line 1158 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 1157 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 1159 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_user_full(), create_addr_from_peer(), parse_ok_contact(), parse_register_contact(), reg_source_db(), register_verify(), sip_poke_peer(), and update_peer().

struct ast_ha* ha

Access control list

Definition at line 1198 of file chan_sip.c.

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

int inRinging

Number of calls ringing

Definition at line 1164 of file chan_sip.c.

Referenced by sip_devicestate(), and update_call_counter().

int inUse

Number of calls in use

Definition at line 1163 of file chan_sip.c.

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

char language[MAX_LANGUAGE]

Default language for prompts

Definition at line 1170 of file chan_sip.c.

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

int lastms

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

Definition at line 1193 of file chan_sip.c.

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

int lastmsg

Definition at line 1202 of file chan_sip.c.

Referenced by _sip_show_peer().

time_t lastmsgcheck

Last time we checked for MWI

Definition at line 1176 of file chan_sip.c.

Referenced by does_peer_need_mwi(), and sip_send_mwi_to_peer().

int lastmsgssent

Definition at line 1175 of file chan_sip.c.

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

char mailbox[AST_MAX_EXTENSION]

Mailbox setting for MWI checks

Definition at line 1169 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), does_peer_need_mwi(), function_sippeer(), handle_request_subscribe(), set_peer_defaults(), and sip_send_mwi_to_peer().

int maxcallbitrate

Maximum Bitrate for a video call

Definition at line 1187 of file chan_sip.c.

Referenced by _sip_show_peer(), check_user_full(), 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 1194 of file chan_sip.c.

Referenced by build_peer(), check_user_full(), 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 1148 of file chan_sip.c.

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

char mohinterpret[MAX_MUSICCLASS]

Music on Hold class

Definition at line 1171 of file chan_sip.c.

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

char mohsuggest[MAX_MUSICCLASS]

Music on Hold class

Definition at line 1172 of file chan_sip.c.

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

struct sip_pvt* mwipvt

Subscription for MWI

Definition at line 1201 of file chan_sip.c.

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

char name[80]

Definition at line 1145 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_user_full(), 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(), sip_poke_peer_s(), update_call_counter(), and update_peer().

struct sip_peer* next[1]

Definition at line 1145 of file chan_sip.c.

unsigned int objflags

Definition at line 1145 of file chan_sip.c.

Referenced by build_peer().

int onHold

Peer has someone on hold

Definition at line 1165 of file chan_sip.c.

Referenced by sip_devicestate(), and sip_peer_hold().

ast_group_t pickupgroup

Pickup group

Definition at line 1185 of file chan_sip.c.

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

int pokeexpire

When to expire poke (qualify= checking)

Definition at line 1192 of file chan_sip.c.

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

unsigned int portinuri

Whether the port should be included in the URI

Definition at line 1188 of file chan_sip.c.

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

struct ast_codec_pref prefs

codec prefs

Definition at line 1174 of file chan_sip.c.

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

struct timeval ps

Ping send time

Definition at line 1195 of file chan_sip.c.

Referenced by handle_response_peerpoke(), and sip_poke_peer().

unsigned int refcount

Definition at line 1145 of file chan_sip.c.

char regexten[AST_MAX_EXTENSION]

Extension to register (if regcontext is used)

Definition at line 1156 of file chan_sip.c.

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

int rtpholdtimeout

RTP Hold Timeout

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

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

int rtptimeout

RTP timeout

Definition at line 1181 of file chan_sip.c.

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

char secret[80]

name, refcount, objflags, object pointers peer->name is the unique name of this object Password

Definition at line 1145 of file chan_sip.c.

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

unsigned int sipoptions

Supported SIP options

Definition at line 1177 of file chan_sip.c.

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

char subscribecontext[AST_MAX_CONTEXT]

Default context for subscriptions

Definition at line 1151 of file chan_sip.c.

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

char tohost[MAXHOSTNAMELEN]

If not dynamic, IP address

Definition at line 1155 of file chan_sip.c.

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

char useragent[256]

User agent in SIP request (saved from registration)

Definition at line 1173 of file chan_sip.c.

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

char username[80]

Temporary username until registration

Definition at line 1152 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), check_user_full(), 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 1168 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 Sat Aug 6 00:40:09 2011 for Asterisk - the Open Source PBX by  doxygen 1.4.7