Asterisk - The Open Source Telephony Project  18.5.0
Data Fields
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_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 1273 of file sip.h.

Field Documentation

◆ __field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

Definition at line 1306 of file sip.h.

◆ accountcode

const ast_string_field accountcode

◆ acl

struct ast_acl_list* acl

◆ addr

struct ast_sockaddr addr

◆ allowtransfer

enum transfermodes allowtransfer

◆ amaflags

int amaflags

AMA Flags (for billing)

Definition at line 1323 of file sip.h.

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

◆ auth

struct sip_auth_container* auth

Realm authentication credentials

Definition at line 1322 of file sip.h.

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

◆ autoframing

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 1317 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().

◆ busy_level

int busy_level

Level of active channels where we signal busy

Definition at line 1330 of file sip.h.

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

◆ call

struct sip_pvt* call

◆ call_limit

int call_limit

◆ callback

const ast_string_field callback

Callback extension

Definition at line 1306 of file sip.h.

Referenced by build_peer(), and peer_ipcmp_cb_full().

◆ callgroup

ast_group_t callgroup

◆ callingpres

int callingpres

Calling id presentation

Definition at line 1324 of file sip.h.

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

◆ caps

struct ast_format_cap* caps

◆ cc_params

struct ast_cc_config_params* cc_params

Definition at line 1377 of file sip.h.

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

◆ chanvars

struct ast_variable* chanvars

Variables to set for channel created by user

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

◆ cid_name

const ast_string_field cid_name

Caller ID name

Definition at line 1306 of file sip.h.

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

◆ cid_num

const ast_string_field cid_num

Caller ID num

Definition at line 1306 of file sip.h.

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

◆ cid_tag

const ast_string_field cid_tag

Caller ID tag

Definition at line 1306 of file sip.h.

Referenced by check_peer_ok(), and create_addr_from_peer().

◆ contactacl

struct ast_acl_list* contactacl

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

Definition at line 1364 of file sip.h.

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

◆ context

const ast_string_field context

Default context for incoming calls

Definition at line 1306 of file sip.h.

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

◆ defaddr

struct ast_sockaddr defaddr

Default IP address, used until registration

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

◆ default_outbound_transport

enum ast_transport default_outbound_transport

Peer Registration may change the default outbound transport. If register expires, default should be reset. to this value

Definition at line 1308 of file sip.h.

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

◆ deprecated_username

unsigned short deprecated_username

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

Definition at line 1321 of file sip.h.

Referenced by build_peer(), and update_peer().

◆ description

const ast_string_field description

Description of this peer

Definition at line 1306 of file sip.h.

Referenced by _sip_show_peer(), _sip_show_peers_one(), Parameter::load(), Api::load(), Property::load(), Model::load(), and ResourceApi::load().

◆ directmediaacl

struct ast_acl_list* directmediaacl

Restrict what IPs are allowed to interchange direct media with

Definition at line 1365 of file sip.h.

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

◆ disallowed_methods

unsigned int disallowed_methods

◆ dnsmgr

struct ast_dnsmgr_entry* dnsmgr

DNS refresh manager for peer

Definition at line 1351 of file sip.h.

Referenced by build_peer(), and match_and_cleanup_peer_sched().

◆ dtls_cfg

struct ast_rtp_dtls_cfg dtls_cfg

Definition at line 1381 of file sip.h.

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

◆ endpoint

struct ast_endpoint* endpoint

◆ engine

const ast_string_field engine

RTP Engine to use

Definition at line 1306 of file sip.h.

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

◆ expire

int expire

◆ first

struct sip_mailbox* first

Definition at line 1338 of file sip.h.

◆ flags

struct ast_flags flags[3]

◆ fromdomain

const ast_string_field fromdomain

From: domain when calling this peer

Definition at line 1306 of file sip.h.

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

◆ fromdomainport

int fromdomainport

The From: domain port

Definition at line 1371 of file sip.h.

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

◆ fromuser

const ast_string_field fromuser

From: user when calling this peer

Definition at line 1306 of file sip.h.

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

◆ fullcontact

const ast_string_field fullcontact

Contact registered with us (not in sip.conf)

Definition at line 1306 of file sip.h.

Referenced by _sip_show_peer(), check_peer_ok(), create_addr_from_peer(), parse_register_contact(), register_verify(), sip_poke_peer(), sip_request_call(), and update_peer().

◆ host_dynamic

unsigned short host_dynamic

Dynamic Peers register with Asterisk

Definition at line 1314 of file sip.h.

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

◆ inuse

int inuse

Number of calls in use

Definition at line 1325 of file sip.h.

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

◆ is_realtime

unsigned short is_realtime

◆ keepalive

int keepalive

Keepalive: How often to send keep alive packet

Definition at line 1360 of file sip.h.

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

◆ keepalivesend

int keepalivesend

Keepalive: Scheduled item for sending keep alive packet

Definition at line 1361 of file sip.h.

Referenced by build_peer(), peer_sched_cleanup(), sip_keepalive_all_peers(), sip_send_keepalive(), and temp_peer().

◆ language

const ast_string_field language

Default language for prompts

Definition at line 1306 of file sip.h.

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

◆ last

struct sip_mailbox* last

Definition at line 1338 of file sip.h.

◆ lastms

int lastms

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

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

◆ lastmsgssent

int lastmsgssent

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

Definition at line 1333 of file sip.h.

Referenced by _sip_show_peer(), and update_peer_lastmsgssent().

◆ mailboxes

struct { ... } mailboxes

◆ maxcallbitrate

int maxcallbitrate

Maximum Bitrate for a video call

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

◆ maxforwards

int maxforwards

SIP Loop prevention

Definition at line 1331 of file sip.h.

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

◆ maxms

int maxms

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

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

◆ md5secret

const ast_string_field md5secret

◆ messagecontext

const ast_string_field messagecontext

Default context for outofcall messages.

Definition at line 1306 of file sip.h.

Referenced by check_peer_ok(), and receive_message().

◆ mohinterpret

const ast_string_field mohinterpret

Music on Hold class

Definition at line 1306 of file sip.h.

Referenced by check_peer_ok(), and create_addr_from_peer().

◆ mohsuggest

const ast_string_field mohsuggest

Music on Hold class

Definition at line 1306 of file sip.h.

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

◆ mwi_from

const ast_string_field mwi_from

Name to place in From header for outgoing NOTIFY requests

Definition at line 1306 of file sip.h.

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

◆ mwipvt

struct sip_pvt* mwipvt

Subscription for MWI

Definition at line 1367 of file sip.h.

Referenced by dialog_unlink_all(), handle_request_subscribe(), sip_destroy_peer(), sip_pvt_dtor(), and sip_send_mwi_to_peer().

◆ name

char name[80]

◆ named_callgroups

struct ast_namedgroups* named_callgroups

◆ named_pickupgroups

struct ast_namedgroups* named_pickupgroups

◆ onhold

int onhold

Peer has someone on hold

Definition at line 1327 of file sip.h.

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

◆ outboundproxy

struct sip_proxy* outboundproxy

Outbound proxy for this peer

Definition at line 1350 of file sip.h.

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

◆ parkinglot

const ast_string_field parkinglot

Parkinglot

Definition at line 1306 of file sip.h.

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

◆ path

struct sip_route path

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

Definition at line 1372 of file sip.h.

Referenced by _sip_show_peer(), build_path(), create_addr_from_peer(), Api::load(), ResourceApi::load(), parse_register_contact(), sip_destroy_peer(), sip_poke_peer(), and update_peer().

◆ pickupgroup

ast_group_t pickupgroup

◆ pokeexpire

int pokeexpire

Qualification: When to expire poke (qualify= checking)

Definition at line 1355 of file sip.h.

Referenced by build_peer(), handle_response_peerpoke(), peer_sched_cleanup(), reg_source_db(), sip_poke_all_peers(), sip_poke_noanswer(), sip_poke_peer(), sip_poke_peer_now(), sip_poke_peer_s(), and temp_peer().

◆ portinuri

unsigned int portinuri

Whether the port should be included in the URI

Definition at line 1353 of file sip.h.

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

◆ ps

struct timeval ps

Qualification: Time for sending SIP OPTION in sip_pke_peer()

Definition at line 1359 of file sip.h.

Referenced by handle_response_peerpoke(), and sip_poke_peer().

◆ qualifyfreq

int qualifyfreq

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

Definition at line 1358 of file sip.h.

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

◆ record_off_feature

const ast_string_field record_off_feature

Feature to use when receiving INFO with record: off during a call

Definition at line 1306 of file sip.h.

Referenced by _sip_show_peer(), and handle_request_info().

◆ record_on_feature

const ast_string_field record_on_feature

Feature to use when receiving INFO with record: on during a call

Definition at line 1306 of file sip.h.

Referenced by _sip_show_peer(), and handle_request_info().

◆ regexten

const ast_string_field regexten

Extension to register (if regcontext is used)

Definition at line 1306 of file sip.h.

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

◆ remotesecret

const ast_string_field remotesecret

Remote secret (trunks, remote devices)

Definition at line 1306 of file sip.h.

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

◆ ringing

int ringing

Number of calls ringing

Definition at line 1326 of file sip.h.

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

◆ rt_fromcontact

unsigned short rt_fromcontact

copy fromcontact from realtime

Definition at line 1313 of file sip.h.

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

◆ rtpholdtimeout

int rtpholdtimeout

RTP Hold Timeout

Definition at line 1344 of file sip.h.

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

◆ rtpkeepalive

int rtpkeepalive

Send RTP packets for keepalive

Definition at line 1345 of file sip.h.

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

◆ rtptimeout

int rtptimeout

RTP timeout

Definition at line 1343 of file sip.h.

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

◆ secret

const ast_string_field secret

◆ selfdestruct

unsigned short selfdestruct

Automatic peers need to destruct themselves

Definition at line 1315 of file sip.h.

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

◆ sipoptions

unsigned int sipoptions

Supported SIP options

Definition at line 1334 of file sip.h.

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

◆ socket

struct sip_socket socket

◆ stimer

struct sip_st_cfg stimer

SIP Session-Timers

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

◆ subscribecontext

const ast_string_field subscribecontext

Default context for subscriptions

Definition at line 1306 of file sip.h.

Referenced by _sip_show_peer(), and check_peer_ok().

◆ t38_maxdatagram

unsigned int t38_maxdatagram

T.38 FaxMaxDatagram override

Definition at line 1329 of file sip.h.

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

◆ the_mark

unsigned short the_mark

That which bears the_mark should be deleted!

Definition at line 1316 of file sip.h.

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

◆ timer_b

int timer_b

The maximum timer B (transaction timeouts)

Definition at line 1370 of file sip.h.

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

◆ timer_t1

int timer_t1

The maximum T1 value for the peer

Definition at line 1369 of file sip.h.

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

◆ tohost

const ast_string_field tohost

If not dynamic struct ast_string_field_mgr __field_mgr IP address

Definition at line 1306 of file sip.h.

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

◆ transports

unsigned short transports

Transports (enum ast_transport) that are acceptable for this peer

Definition at line 1311 of file sip.h.

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

◆ type

enum sip_peer_type type

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

Definition at line 1375 of file sip.h.

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

◆ unsolicited_mailbox

const ast_string_field unsolicited_mailbox

Mailbox to store received unsolicited MWI NOTIFY messages information in

Definition at line 1306 of file sip.h.

Referenced by handle_request_notify().

◆ useragent

const ast_string_field useragent

User agent in SIP request (saved from registration)

Definition at line 1306 of file sip.h.

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

◆ username

const ast_string_field username

◆ vmexten

const ast_string_field vmexten

Dialplan extension for MWI notify message

Definition at line 1306 of file sip.h.

Referenced by _sip_show_peer(), and sip_send_mwi_to_peer().

◆ zone

const ast_string_field zone

Tonezone for this device

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