Tue Mar 2 17:35:38 2010

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:
Collaboration graph
[legend]

Data Fields

char accountcode [AST_MAX_ACCOUNT_CODE]
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
char cid_name [80]
char cid_num [80]
struct ast_hacontactha
char context [AST_MAX_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]
char fromdomain [MAXHOSTNAMELEN]
char fromuser [80]
char fullcontact [256]
struct ast_haha
char host_dynamic
int inRinging
int inUse
char is_realtime
char language [MAX_LANGUAGE]
int lastms
int lastmsgssent
struct {
   struct sip_mailbox *   first
   struct sip_mailbox *   last
mailboxes
int maxcallbitrate
int maxms
char md5secret [80]
char mohinterpret [MAX_MUSICCLASS]
char mohsuggest [MAX_MUSICCLASS]
struct sip_pvtmwipvt
char name [80]
int onHold
struct sip_proxyoutboundproxy
char parkinglot [AST_MAX_CONTEXT]
ast_group_t pickupgroup
int pokeexpire
unsigned int portinuri:1
struct ast_codec_pref prefs
struct timeval ps
int qualifyfreq
char regexten [AST_MAX_EXTENSION]
char rt_fromcontact
int rtpholdtimeout
int rtpkeepalive
int rtptimeout
char secret [80]
char selfdestruct
unsigned int sipoptions
struct sip_socket socket
struct sip_st_cfg stimer
char subscribecontext [AST_MAX_CONTEXT]
int t38_maxdatagram
char the_mark
int timer_b
int timer_t1
char tohost [MAXHOSTNAMELEN]
unsigned int transports:3
enum sip_peer_type type
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 1509 of file chan_sip.c.


Field Documentation

char accountcode[AST_MAX_ACCOUNT_CODE]

Account code

Definition at line 1520 of file chan_sip.c.

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

struct sockaddr_in addr [read]
int amaflags

AMA Flags (for billing)

Definition at line 1521 of file chan_sip.c.

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

struct sip_auth* auth [read]

Realm authentication list

Definition at line 1516 of file chan_sip.c.

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

Level of active channels where we signal busy

Definition at line 1535 of file chan_sip.c.

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

struct sip_pvt* call [read]

Calling id presentation

Definition at line 1529 of file chan_sip.c.

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

Codec capability

Definition at line 1559 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 [read]

Variables to set for channel created by user

Definition at line 1581 of file chan_sip.c.

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

char cid_name[80]

Caller ID name

Definition at line 1528 of file chan_sip.c.

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

char cid_num[80]

Caller ID num

Definition at line 1527 of file chan_sip.c.

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

struct ast_ha* contactha [read]

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

Definition at line 1580 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 1517 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_show_user(), and sip_show_users().

struct sockaddr_in defaddr [read]

Default IP address, used until registration

Definition at line 1578 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.

Definition at line 1512 of file chan_sip.c.

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

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

Definition at line 1587 of file chan_sip.c.

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

struct ast_dnsmgr_entry* dnsmgr [read]

DNS refresh manager for peer

Definition at line 1566 of file chan_sip.c.

Referenced by build_peer(), and sip_destroy_peer().

int expire
struct sip_mailbox* first [read]

Definition at line 1549 of file chan_sip.c.

struct ast_flags flags[2] [read]
char fromdomain[MAXHOSTNAMELEN]

From: domain when calling this peer

Definition at line 1525 of file chan_sip.c.

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

char fromuser[80]

From: user when calling this peer

Definition at line 1524 of file chan_sip.c.

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

char fullcontact[256]

Contact registered with us (not in sip.conf)

Definition at line 1526 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(), register_verify(), sip_poke_peer(), and update_peer().

struct ast_ha* ha [read]

P: Dynamic Peers register with Asterisk

Definition at line 1554 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 1531 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 1530 of file chan_sip.c.

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

char language[MAX_LANGUAGE]

Default language for prompts

Definition at line 1538 of file chan_sip.c.

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

struct sip_mailbox* last [read]

Definition at line 1549 of file chan_sip.c.

int lastms

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

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

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

struct { ... } mailboxes

Maximum Bitrate for a video call

Definition at line 1568 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 1575 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]
char mohinterpret[MAX_MUSICCLASS]

Music on Hold class

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

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

struct sip_pvt* mwipvt [read]

Subscription for MWI

Definition at line 1582 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]
int onHold

Peer has someone on hold

Definition at line 1532 of file chan_sip.c.

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

struct sip_proxy* outboundproxy [read]

Outbound proxy for this peer

Definition at line 1565 of file chan_sip.c.

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

char parkinglot[AST_MAX_CONTEXT]

Parkinglot

Definition at line 1541 of file chan_sip.c.

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

When to expire poke (qualify= checking)

Definition at line 1573 of file chan_sip.c.

Referenced by handle_response_peerpoke(), reg_source_db(), set_peer_defaults(), sip_poke_all_peers(), 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 1569 of file chan_sip.c.

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

struct ast_codec_pref prefs [read]
struct timeval ps [read]

Time for sending SIP OPTION in sip_pke_peer()

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

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

char regexten[AST_MAX_EXTENSION]

Extension to register (if regcontext is used)

Definition at line 1523 of file chan_sip.c.

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

P: copy fromcontact from realtime

Definition at line 1553 of file chan_sip.c.

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

RTP Hold Timeout

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

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

RTP timeout

Definition at line 1560 of file chan_sip.c.

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

char secret[80]

P: Automatic peers need to destruct themselves

Definition at line 1555 of file chan_sip.c.

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

unsigned int sipoptions

Supported SIP options

Definition at line 1545 of file chan_sip.c.

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

struct sip_socket socket [read]
struct sip_st_cfg stimer [read]

SIP Session-Timers

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

char subscribecontext[AST_MAX_CONTEXT]

Default context for subscriptions

Definition at line 1518 of file chan_sip.c.

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

T.38 FaxMaxDatagram override

Definition at line 1534 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 1556 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 1586 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 1585 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 1522 of file chan_sip.c.

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

unsigned int transports

Transports (enum sip_transport) that are acceptable for this peer

Definition at line 1513 of file chan_sip.c.

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

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

Definition at line 1588 of file chan_sip.c.

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

char useragent[256]

User agent in SIP request (saved from registration)

Definition at line 1542 of file chan_sip.c.

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

char username[80]
char vmexten[AST_MAX_EXTENSION]

SIP Refer restriction scheme Dialplan extension for MWI notify message

Definition at line 1537 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 2 Mar 2010 for Asterisk - the Open Source PBX by  doxygen 1.6.1