Mon Nov 24 15:34:53 2008

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


Public Member Functions

 ASTOBJ_COMPONENTS (struct sip_peer)

Data Fields

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]
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
int onHold
ast_group_t pickupgroup
int pokeexpire
ast_codec_pref prefs
timeval ps
char regexten [AST_MAX_EXTENSION]
int rtpholdtimeout
int rtpkeepalive
int rtptimeout
char secret [80]
unsigned int sipoptions
int sockfd
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 1083 of file chan_sip.c.


Member Function Documentation

ASTOBJ_COMPONENTS ( struct  sip_peer  ) 

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


Field Documentation

char accountcode[AST_MAX_ACCOUNT_CODE]

Account code

Definition at line 1092 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 1125 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 1106 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 1093 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 1088 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 1140 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 1129 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 1105 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 1123 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 1101 of file chan_sip.c.

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

int capability

Codec capability

Definition at line 1119 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 1137 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 1100 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 1099 of file chan_sip.c.

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

char context[AST_MAX_CONTEXT]

Default context for incoming calls

Definition at line 1089 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 1135 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 1118 of file chan_sip.c.

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

struct ast_flags flags[2]

SIP_ flags

Definition at line 1117 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 1097 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 1096 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 1098 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(), sip_poke_peer(), and update_peer().

struct ast_ha* ha

Access control list

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

Referenced by sip_devicestate(), and update_call_counter().

int inUse

Number of calls in use

Definition at line 1102 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 1109 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 1131 of file chan_sip.c.

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

int lastmsg

Definition at line 1139 of file chan_sip.c.

Referenced by _sip_show_peer().

time_t lastmsgcheck

Last time we checked for MWI

Definition at line 1115 of file chan_sip.c.

Referenced by does_peer_need_mwi(), and sip_send_mwi_to_peer().

int lastmsgssent

Definition at line 1114 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 1108 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 1126 of file chan_sip.c.

Referenced by _sip_show_peer(), build_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 1132 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 1087 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 1110 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 1111 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 1138 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().

int onHold

Peer has someone on hold

Definition at line 1104 of file chan_sip.c.

Referenced by sip_devicestate(), and sip_peer_hold().

ast_group_t pickupgroup

Pickup group

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

struct ast_codec_pref prefs

codec prefs

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

Referenced by handle_response_peerpoke(), and sip_poke_peer().

char regexten[AST_MAX_EXTENSION]

Extension to register (if regcontext is used)

Definition at line 1095 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 1121 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 1122 of file chan_sip.c.

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

int rtptimeout

RTP timeout

Definition at line 1120 of file chan_sip.c.

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

char secret[80]

Password

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

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

int sockfd

Socket used by this peer for tcp connections

Definition at line 1141 of file chan_sip.c.

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

char subscribecontext[AST_MAX_CONTEXT]

Default context for subscriptions

Definition at line 1090 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 1094 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 1112 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 1091 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 1107 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 Mon Nov 24 15:34:53 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7