Wed Oct 28 13:35:37 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...

Collaboration diagram for sip_peer:

Collaboration graph
[legend]

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
unsigned short autoframing:1
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
unsigned short deprecated_username:1
unsigned int disallowed_methods
struct ast_dnsmgr_entrydnsmgr
const ast_string_field engine
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
unsigned short host_dynamic:1
int inRinging
int inUse
unsigned short is_realtime:1
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
const ast_string_field mwi_from
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
unsigned short rt_fromcontact:1
int rtpholdtimeout
int rtpkeepalive
int rtptimeout
const ast_string_field secret
unsigned short selfdestruct:1
unsigned int sipoptions
struct sip_socket socket
struct sip_st_cfg stimer
const ast_string_field subscribecontext
int t38_maxdatagram
unsigned short the_mark:1
int timer_b
int timer_t1
const ast_string_field tohost
unsigned short transports:3
enum sip_peer_type type
const ast_string_field unsolicited_mailbox
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 1973 of file chan_sip.c.


Field Documentation

Definition at line 1999 of file chan_sip.c.

Definition at line 1999 of file chan_sip.c.

struct sockaddr_in addr [read]

int amaflags

AMA Flags (for billing)

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

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

unsigned short autoframing

Whether to use our local configuration for frame sizes (off) or respect the other endpoint's request for frame sizes (on) for incoming calls

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

Level of active channels where we signal busy

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

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

Codec capability

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

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

Definition at line 2053 of file chan_sip.c.

Referenced by build_peer(), and parse_register_contact().

struct sockaddr_in defaddr [read]

Default IP address, used until registration

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

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

unsigned short deprecated_username

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

Definition at line 2014 of file chan_sip.c.

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

unsigned int disallowed_methods

struct ast_dnsmgr_entry* dnsmgr [read]

DNS refresh manager for peer

Definition at line 2042 of file chan_sip.c.

Referenced by build_peer(), and sip_destroy_peer().

Definition at line 1999 of file chan_sip.c.

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

int expire

struct sip_mailbox* first [read]

Definition at line 2031 of file chan_sip.c.

struct ast_flags flags[2] [read]

Definition at line 1999 of file chan_sip.c.

Referenced by _sip_show_peer(), and create_addr_from_peer().

Definition at line 1999 of file chan_sip.c.

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

struct ast_ha* ha [read]

unsigned short host_dynamic

Dynamic Peers register with Asterisk

Definition at line 2007 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 2019 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 2018 of file chan_sip.c.

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

unsigned short is_realtime

struct sip_mailbox* last [read]

Definition at line 2031 of file chan_sip.c.

int lastms

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

Definition at line 2047 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 2026 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 2033 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

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

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

Referenced by check_peer_ok(), and create_addr_from_peer().

Definition at line 1999 of file chan_sip.c.

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

Definition at line 1999 of file chan_sip.c.

Referenced by create_addr_from_peer(), and sip_send_mwi_to_peer().

struct sip_pvt* mwipvt [read]

Subscription for MWI

Definition at line 2055 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) Name to place in From header for outgoing NOTIFY requests RTP Engine to use Mailbox to store received unsolicited MWI NOTIFY messages information in

Definition at line 1974 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_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 2020 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 2041 of file chan_sip.c.

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

Definition at line 1999 of file chan_sip.c.

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

Qualification: When to expire poke (qualify= checking)

Definition at line 2046 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 2044 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]

SIP Refer restriction scheme codec prefs

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

struct timeval ps [read]

Qualification: Time for sending SIP OPTION in sip_pke_peer()

Definition at line 2050 of file chan_sip.c.

Referenced by handle_response_peerpoke(), and sip_poke_peer().

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

Definition at line 2049 of file chan_sip.c.

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

Definition at line 1999 of file chan_sip.c.

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

Definition at line 1999 of file chan_sip.c.

Referenced by _sip_show_peer(), and build_peer().

unsigned short rt_fromcontact

copy fromcontact from realtime

Definition at line 2006 of file chan_sip.c.

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

RTP Hold Timeout

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

Referenced by build_peer(), and set_peer_defaults().

RTP timeout

Definition at line 2036 of file chan_sip.c.

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

unsigned short selfdestruct

Automatic peers need to destruct themselves

Definition at line 2008 of file chan_sip.c.

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

unsigned int sipoptions

Supported SIP options

Definition at line 2027 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 2056 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 1999 of file chan_sip.c.

Referenced by _sip_show_peer(), and check_peer_ok().

T.38 FaxMaxDatagram override

Definition at line 2022 of file chan_sip.c.

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

unsigned short the_mark

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

Definition at line 2009 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 2058 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 2057 of file chan_sip.c.

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

unsigned short transports

Transports (enum sip_transport) that are acceptable for this peer

Definition at line 2004 of file chan_sip.c.

Referenced by _sip_show_peer(), build_peer(), find_peer(), 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 2061 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().

Definition at line 1999 of file chan_sip.c.

Referenced by handle_request_notify().

Definition at line 1999 of file chan_sip.c.

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

Definition at line 1999 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:

Generated on Wed Oct 28 13:35:38 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6