sip_peer Struct Reference

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

#include <sip.h>

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 ast_acl_listacl
struct ast_sockaddr addr
enum transfermodes allowtransfer
int amaflags
struct sip_auth_containerauth
unsigned short autoframing:1
int busy_level
struct sip_pvtcall
int call_limit
const ast_string_field callback
ast_group_t callgroup
int callingpres
struct ast_format_capcaps
struct ast_cc_config_paramscc_params
struct ast_variablechanvars
const ast_string_field cid_name
const ast_string_field cid_num
const ast_string_field cid_tag
struct ast_acl_listcontactacl
const ast_string_field context
struct ast_sockaddr defaddr
enum ast_transport default_outbound_transport
unsigned short deprecated_username:1
const ast_string_field description
struct ast_acl_listdirectmediaacl
unsigned int disallowed_methods
struct ast_dnsmgr_entrydnsmgr
struct ast_rtp_dtls_cfg dtls_cfg
struct ast_endpointendpoint
const ast_string_field engine
int expire
struct ast_flags flags [3]
const ast_string_field fromdomain
int fromdomainport
const ast_string_field fromuser
const ast_string_field fullcontact
unsigned short host_dynamic:1
int inuse
unsigned short is_realtime:1
int keepalive
int keepalivesend
const ast_string_field language
int lastms
int lastmsgssent
struct {
   struct sip_mailbox *   first
   struct sip_mailbox *   last
mailboxes
int maxcallbitrate
int maxforwards
int maxms
const ast_string_field md5secret
const ast_string_field messagecontext
const ast_string_field mohinterpret
const ast_string_field mohsuggest
const ast_string_field mwi_from
struct sip_pvtmwipvt
char name [80]
struct ast_namedgroups * named_callgroups
struct ast_namedgroups * named_pickupgroups
int onhold
struct sip_proxyoutboundproxy
const ast_string_field parkinglot
struct sip_route path
ast_group_t pickupgroup
int pokeexpire
unsigned int portinuri:1
struct timeval ps
int qualifyfreq
const ast_string_field record_off_feature
const ast_string_field record_on_feature
const ast_string_field regexten
const ast_string_field remotesecret
int ringing
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
unsigned int t38_maxdatagram
unsigned short the_mark:1
int timer_b
int timer_t1
const ast_string_field tohost
unsigned short transports:5
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
const ast_string_field zone

Detailed Description

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

Definition at line 1251 of file sip.h.


Field Documentation

Definition at line 1284 of file sip.h.

Definition at line 1284 of file sip.h.

struct ast_acl_list* acl [read]

struct ast_sockaddr addr [read]

int amaflags

AMA Flags (for billing)

Definition at line 1301 of file sip.h.

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

struct sip_auth_container* auth [read]

Realm authentication credentials

Definition at line 1300 of file sip.h.

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

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 1295 of file sip.h.

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 1308 of file sip.h.

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

struct sip_pvt* call [read]

Definition at line 1284 of file sip.h.

Referenced by build_peer(), and peer_ipcmp_cb_full().

Calling id presentation

Definition at line 1302 of file sip.h.

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

struct ast_format_cap* caps [read]

Definition at line 1355 of file sip.h.

Referenced by build_peer(), check_peer_ok(), create_addr_from_peer(), sip_destroy_peer(), and temp_peer().

struct ast_variable* chanvars [read]

Variables to set for channel created by user

Definition at line 1344 of file sip.h.

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

Definition at line 1284 of file sip.h.

Referenced by check_peer_ok(), and create_addr_from_peer().

struct ast_acl_list* contactacl [read]

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

Definition at line 1342 of file sip.h.

Referenced by build_peer(), and parse_register_contact().

struct ast_sockaddr defaddr [read]

Default IP address, used until registration

Definition at line 1340 of file sip.h.

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 1286 of file sip.h.

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

unsigned short deprecated_username

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

Definition at line 1299 of file sip.h.

Referenced by build_peer(), and update_peer().

Definition at line 1284 of file sip.h.

Referenced by _sip_show_peer(), and _sip_show_peers_one().

struct ast_acl_list* directmediaacl [read]

Restrict what IPs are allowed to interchange direct media with

Definition at line 1343 of file sip.h.

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

unsigned int disallowed_methods

struct ast_dnsmgr_entry* dnsmgr [read]

DNS refresh manager for peer

Definition at line 1329 of file sip.h.

Referenced by build_peer(), and match_and_cleanup_peer_sched().

struct ast_rtp_dtls_cfg dtls_cfg [read]

Definition at line 1359 of file sip.h.

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

struct ast_endpoint* endpoint [read]

Definition at line 1284 of file sip.h.

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 1316 of file sip.h.

struct ast_flags flags[3] [read]

Definition at line 1284 of file sip.h.

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

The From: domain port

Definition at line 1349 of file sip.h.

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

Definition at line 1284 of file sip.h.

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

unsigned short host_dynamic

Dynamic Peers register with Asterisk

Definition at line 1292 of file sip.h.

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

int inuse

Number of calls in use

Definition at line 1303 of file sip.h.

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

unsigned short is_realtime

int keepalive

Keepalive: How often to send keep alive packet

Definition at line 1338 of file sip.h.

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

Keepalive: Scheduled item for sending keep alive packet

Definition at line 1339 of file sip.h.

Referenced by peer_sched_cleanup(), set_peer_defaults(), sip_keepalive_all_peers(), and sip_send_keepalive().

struct sip_mailbox* last [read]

Definition at line 1316 of file sip.h.

int lastms

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

Definition at line 1334 of file sip.h.

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

SIP Refer restriction scheme The last known VM message counts (new/old)

Definition at line 1311 of file sip.h.

Referenced by _sip_show_peer(), and update_peer_lastmsgssent().

struct { ... } mailboxes

Maximum Bitrate for a video call

Definition at line 1318 of file sip.h.

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

SIP Loop prevention

Definition at line 1309 of file sip.h.

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

int maxms

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

Definition at line 1335 of file sip.h.

Referenced by build_peer(), check_peer_ok(), create_addr_from_peer(), handle_response_peerpoke(), peer_status(), reg_source_db(), send_manager_peer_status(), set_peer_defaults(), sip_devicestate(), sip_poke_all_peers(), and sip_poke_peer().

Definition at line 1284 of file sip.h.

Referenced by check_peer_ok(), and receive_message().

Definition at line 1284 of file sip.h.

Referenced by check_peer_ok(), and create_addr_from_peer().

Definition at line 1284 of file sip.h.

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

Definition at line 1284 of file sip.h.

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

struct sip_pvt* mwipvt [read]

Subscription for MWI

Definition at line 1345 of file sip.h.

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 Description of this peer Remote secret (trunks, remote devices) Default context for incoming calls Default context for outofcall messages. 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 Caller ID tag 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 Tonezone for this device Feature to use when receiving INFO with record: on during a call Feature to use when receiving INFO with record: off during a call Callback extension

Definition at line 1252 of file sip.h.

Referenced by _sip_show_peer(), _sip_show_peers(), _sip_show_peers_one(), add_peer_mwi_subs(), 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(), handle_request_subscribe(), handle_response_invite(), handle_response_peerpoke(), on_dns_update_peer(), parse_register_contact(), peer_cmp_cb(), peer_dump_func(), peer_hash_cb(), realtime_peer(), receive_message(), reg_source_db(), register_peer_exten(), register_realtime_peers_with_callbackextens(), register_verify(), send_manager_peer_status(), show_channels_cb(), sip_destroy_peer(), sip_find_peer_full(), sip_msg_send(), 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().

struct ast_namedgroups* named_callgroups [read]

struct ast_namedgroups* named_pickupgroups [read]

int onhold

Peer has someone on hold

Definition at line 1305 of file sip.h.

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

struct sip_proxy* outboundproxy [read]

Outbound proxy for this peer

Definition at line 1328 of file sip.h.

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

Definition at line 1284 of file sip.h.

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

struct sip_route path [read]

List of out-of-dialog outgoing routing steps (fm Path headers)

Definition at line 1350 of file sip.h.

Referenced by _sip_show_peer(), build_path(), create_addr_from_peer(), parse_register_contact(), sip_destroy_peer(), sip_poke_peer(), and update_peer().

unsigned int portinuri

Whether the port should be included in the URI

Definition at line 1331 of file sip.h.

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

struct timeval ps [read]

Qualification: Time for sending SIP OPTION in sip_pke_peer()

Definition at line 1337 of file sip.h.

Referenced by handle_response_peerpoke(), and sip_poke_peer().

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

Definition at line 1336 of file sip.h.

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

Definition at line 1284 of file sip.h.

Referenced by _sip_show_peer(), and handle_request_info().

Definition at line 1284 of file sip.h.

Referenced by _sip_show_peer(), and handle_request_info().

Definition at line 1284 of file sip.h.

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

Definition at line 1284 of file sip.h.

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

int ringing

Number of calls ringing

Definition at line 1304 of file sip.h.

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

unsigned short rt_fromcontact

copy fromcontact from realtime

Definition at line 1291 of file sip.h.

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

RTP Hold Timeout

Definition at line 1322 of file sip.h.

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

Send RTP packets for keepalive

Definition at line 1323 of file sip.h.

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

RTP timeout

Definition at line 1321 of file sip.h.

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

unsigned short selfdestruct

Automatic peers need to destruct themselves

Definition at line 1293 of file sip.h.

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

unsigned int sipoptions

Supported SIP options

Definition at line 1312 of file sip.h.

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

struct sip_socket socket [read]

struct sip_st_cfg stimer [read]

SIP Session-Timers

Definition at line 1346 of file sip.h.

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 1284 of file sip.h.

Referenced by _sip_show_peer(), and check_peer_ok().

unsigned int t38_maxdatagram

T.38 FaxMaxDatagram override

Definition at line 1307 of file sip.h.

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

unsigned short the_mark

That which bears the_mark should be deleted!

Definition at line 1294 of file sip.h.

Referenced by build_peer(), match_and_cleanup_peer_sched(), peer_markall_autopeers_func(), peer_markall_func(), and sip_prune_realtime().

int timer_b

The maximum timer B (transaction timeouts)

Definition at line 1348 of file sip.h.

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 1347 of file sip.h.

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

unsigned short transports

Transports (enum ast_transport) that are acceptable for this peer

Definition at line 1289 of file sip.h.

Referenced by _sip_show_peer(), build_peer(), parse_register_contact(), peer_ipcmp_cb_full(), peers_data_provider_get(), set_peer_defaults(), and sip_find_peer_full().

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

Definition at line 1353 of file sip.h.

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

Definition at line 1284 of file sip.h.

Referenced by handle_request_notify().

Definition at line 1284 of file sip.h.

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

Definition at line 1284 of file sip.h.

Referenced by _sip_show_peer(), and sip_send_mwi_to_peer().

Definition at line 1284 of file sip.h.

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


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

Generated on Thu Apr 16 06:37:22 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6