Asterisk - The Open Source Telephony Project GIT-master-f36a736
Public Member Functions | Data Fields
ast_sip_endpoint Struct Reference

An entity with which Asterisk communicates. More...

#include <res_pjsip.h>

Collaboration diagram for ast_sip_endpoint:
Collaboration graph
[legend]

Public Member Functions

 AST_STRING_FIELD_EXTENDED (geoloc_incoming_call_profile)
 
 AST_STRING_FIELD_EXTENDED (geoloc_outgoing_call_profile)
 
 AST_STRING_FIELD_EXTENDED (overlap_context)
 
 AST_STRING_FIELD_EXTENDED (tenantid)
 
 SORCERY_OBJECT (details)
 

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
 
unsigned int allow_overlap
 
unsigned int allow_unauthenticated_options
 
unsigned int allowtransfer
 
const ast_string_field aors
 
unsigned int asymmetric_rtp_codec
 
struct ast_variablechannel_vars
 
struct ast_acl_listcontact_acl
 
char * contact_user
 
const ast_string_field context
 
unsigned int devicestate_busy_at
 
enum ast_sip_dtmf_mode dtmf
 
struct ast_sip_endpoint_extensions extensions
 
unsigned int faxdetect
 
unsigned int faxdetect_timeout
 
const ast_string_field fromdomain
 
const ast_string_field fromuser
 
struct ast_sip_endpoint_id_configuration id
 
enum ast_sip_endpoint_identifier_type ident_method
 
struct ast_sip_identify_by_vector ident_method_order
 
unsigned int ignore_183_without_sdp
 
unsigned int inband_progress
 
struct ast_sip_auth_vector inbound_auths
 
const ast_string_field incoming_mwi_mailbox
 
struct ast_sip_endpoint_info_configuration info
 
const ast_string_field language
 
struct ast_sip_endpoint_media_configuration media
 
const ast_string_field message_context
 
unsigned int moh_passthrough
 
const ast_string_field mohsuggest
 
struct ast_sip_endpoint_nat_configuration nat
 
unsigned int notify_early_inuse_ringing
 
struct ast_sip_auth_vector outbound_auths
 
const ast_string_field outbound_proxy
 
struct ast_endpointpersistent
 
struct ast_sip_endpoint_pickup_configuration pickup
 
unsigned int preferred_codec_only
 
enum ast_sip_session_redirect redirect_method
 
unsigned int refer_blind_progress
 
enum ast_sip_100rel_mode rel100
 
struct ast_sip_security_mechanism_vector security_mechanisms
 
enum ast_sip_security_negotiation security_negotiation
 
unsigned int send_aoc
 
unsigned int stir_shaken
 
const ast_string_field stir_shaken_profile
 
struct ast_sip_endpoint_subscription_configuration subscription
 
int suppress_moh_on_sendonly
 
unsigned int suppress_q850_reason_headers
 
const ast_string_field transport
 
unsigned int usereqphone
 
const ast_string_field zone
 

Detailed Description

An entity with which Asterisk communicates.

Definition at line 958 of file res_pjsip.h.

Member Function Documentation

◆ AST_STRING_FIELD_EXTENDED() [1/4]

AST_STRING_FIELD_EXTENDED ( geoloc_incoming_call_profile  )

The name of the geoloc profile to apply when Asterisk receives a call from this endpoint

◆ AST_STRING_FIELD_EXTENDED() [2/4]

AST_STRING_FIELD_EXTENDED ( geoloc_outgoing_call_profile  )

The name of the geoloc profile to apply when Asterisk sends a call to this endpoint

◆ AST_STRING_FIELD_EXTENDED() [3/4]

AST_STRING_FIELD_EXTENDED ( overlap_context  )

The context to use for overlap dialing, if different from the endpoint's context

◆ AST_STRING_FIELD_EXTENDED() [4/4]

AST_STRING_FIELD_EXTENDED ( tenantid  )

Tenant ID for the endpoint

◆ SORCERY_OBJECT()

SORCERY_OBJECT ( details  )

Field Documentation

◆ __field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 987 of file res_pjsip.h.

◆ __field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

Context to send incoming calls to

Name of an explicit transport to use

Outbound proxy to use

Explicit AORs to dial if none are specified

Musiconhold class to suggest that the other side use when placing on hold

Configured tone zone for this endpoint.

Configured language for this endpoint.

Default username to place in From header

Domain to place in From header

Context to route incoming MESSAGE requests to

Accountcode to auto-set on channels

If set, we'll push incoming MWI NOTIFYs to stasis using this mailbox

STIR/SHAKEN profile to use

Definition at line 987 of file res_pjsip.h.

◆ accountcode

const ast_string_field accountcode

Definition at line 987 of file res_pjsip.h.

◆ acl

struct ast_acl_list* acl

Access control list

Definition at line 1031 of file res_pjsip.h.

Referenced by acl_to_str(), apply_endpoint_acl(), endpoint_acl_handler(), and endpoint_destructor().

◆ allow_overlap

unsigned int allow_overlap

Do we allow overlap dialling?

Definition at line 1043 of file res_pjsip.h.

◆ allow_unauthenticated_options

unsigned int allow_unauthenticated_options

Should we authenticate OPTIONS requests per RFC 3261?

Definition at line 1059 of file res_pjsip.h.

Referenced by ast_sip_requires_authentication().

◆ allowtransfer

unsigned int allowtransfer

Determines if transfers (using REFER) are allowed by this endpoint

Definition at line 1021 of file res_pjsip.h.

◆ aors

const ast_string_field aors

◆ asymmetric_rtp_codec

unsigned int asymmetric_rtp_codec

Do we allow an asymmetric RTP codec?

Definition at line 1041 of file res_pjsip.h.

◆ channel_vars

struct ast_variable* channel_vars

Variables set on channel creation

Definition at line 1025 of file res_pjsip.h.

Referenced by endpoint_destructor(), set_var_handler(), set_var_to_str(), and set_var_to_vl().

◆ contact_acl

struct ast_acl_list* contact_acl

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

Definition at line 1033 of file res_pjsip.h.

Referenced by apply_endpoint_contact_acl(), contact_acl_to_str(), endpoint_acl_handler(), and endpoint_destructor().

◆ contact_user

char* contact_user

Override the user on the outgoing Contact header with this value.

Definition at line 1037 of file res_pjsip.h.

Referenced by ast_sip_create_dialog_uac(), contact_user_handler(), contact_user_to_str(), create_dialog_uas(), create_out_of_dialog_request(), and endpoint_destructor().

◆ context

const ast_string_field context

◆ devicestate_busy_at

unsigned int devicestate_busy_at

The number of channels at which busy device state is returned

Definition at line 1017 of file res_pjsip.h.

Referenced by cli_endpoint_print_body().

◆ dtmf

enum ast_sip_dtmf_mode dtmf

DTMF mode to use with this endpoint

Definition at line 1007 of file res_pjsip.h.

Referenced by ast_sip_session_alloc(), dtmf_handler(), and dtmf_to_str().

◆ extensions

struct ast_sip_endpoint_extensions extensions

◆ faxdetect

unsigned int faxdetect

Whether fax detection is enabled or not (CNG tone detection)

Definition at line 1019 of file res_pjsip.h.

Referenced by ast_sip_session_alloc().

◆ faxdetect_timeout

unsigned int faxdetect_timeout

The number of seconds into call to disable fax detection. (0 = disabled)

Definition at line 1035 of file res_pjsip.h.

◆ fromdomain

const ast_string_field fromdomain

◆ fromuser

const ast_string_field fromuser

◆ id

◆ ident_method

Method(s) by which the endpoint should be identified.

Definition at line 1009 of file res_pjsip.h.

Referenced by auth_username_identify(), ident_handler(), and username_identify().

◆ ident_method_order

struct ast_sip_identify_by_vector ident_method_order

Order of the method(s) by which the endpoint should be identified.

Definition at line 1011 of file res_pjsip.h.

Referenced by ast_sip_endpoint_alloc(), endpoint_destructor(), find_registrar_aor(), ident_handler(), and ident_to_str().

◆ ignore_183_without_sdp

unsigned int ignore_183_without_sdp

Ignore 183 if no SDP is present

Definition at line 1051 of file res_pjsip.h.

◆ inband_progress

unsigned int inband_progress

Boolean indicating if ringing should be sent as inband progress

Definition at line 1013 of file res_pjsip.h.

Referenced by chan_pjsip_indicate().

◆ inbound_auths

struct ast_sip_auth_vector inbound_auths

◆ incoming_mwi_mailbox

const ast_string_field incoming_mwi_mailbox

Definition at line 987 of file res_pjsip.h.

◆ info

Configuration options for INFO packages

Definition at line 999 of file res_pjsip.h.

Referenced by ast_sip_create_dialog_uac(), ast_sip_endpoint_alloc(), and endpoint_destructor().

◆ language

const ast_string_field language

Definition at line 987 of file res_pjsip.h.

◆ media

◆ message_context

const ast_string_field message_context

Definition at line 987 of file res_pjsip.h.

◆ moh_passthrough

unsigned int moh_passthrough

Whether to pass through hold and unhold using re-invites with recvonly and sendrecv

Definition at line 1029 of file res_pjsip.h.

Referenced by ast_sip_session_alloc().

◆ mohsuggest

const ast_string_field mohsuggest

Definition at line 987 of file res_pjsip.h.

◆ nat

NAT configuration

Definition at line 995 of file res_pjsip.h.

Referenced by ast_res_pjsip_initialize_configuration(), ast_sip_will_uri_survive_restart(), and handle_rx_message().

◆ notify_early_inuse_ringing

unsigned int notify_early_inuse_ringing

Whether to notifies dialog-info 'early' on INUSE && RINGING state

Definition at line 1047 of file res_pjsip.h.

Referenced by dialog_info_generate_body_content().

◆ outbound_auths

struct ast_sip_auth_vector outbound_auths

◆ outbound_proxy

const ast_string_field outbound_proxy

◆ persistent

struct ast_endpoint* persistent

Pointer to the persistent Asterisk endpoint

Definition at line 1015 of file res_pjsip.h.

Referenced by ast_sip_get_endpoint_snapshot(), endpoint_deleted_observer(), endpoint_destructor(), and sip_endpoint_apply_handler().

◆ pickup

◆ preferred_codec_only

unsigned int preferred_codec_only

Whether to response SDP offer with single most preferred codec.

Definition at line 1039 of file res_pjsip.h.

Referenced by new_invite(), and sip_endpoint_apply_handler().

◆ redirect_method

enum ast_sip_session_redirect redirect_method

Method used when handling redirects

Definition at line 1023 of file res_pjsip.h.

Referenced by redirect_handler().

◆ refer_blind_progress

unsigned int refer_blind_progress

Whether to notifies all the progress details on blind transfer

Definition at line 1045 of file res_pjsip.h.

◆ rel100

enum ast_sip_100rel_mode rel100

100rel mode to use with this endpoint

Definition at line 1067 of file res_pjsip.h.

Referenced by prack_handler(), prack_to_str(), and pre_session_setup().

◆ security_mechanisms

struct ast_sip_security_mechanism_vector security_mechanisms

Client security mechanisms (RFC 3329).

Definition at line 1055 of file res_pjsip.h.

Referenced by add_outgoing_request_headers(), endpoint_destructor(), security_mechanism_handler(), and security_mechanism_to_str().

◆ security_negotiation

enum ast_sip_security_negotiation security_negotiation

Type of security negotiation to use (RFC 3329).

Definition at line 1053 of file res_pjsip.h.

Referenced by add_outgoing_request_headers(), ast_sip_set_security_negotiation(), security_negotiation_handler(), and security_negotiation_to_str().

◆ send_aoc

unsigned int send_aoc

Send Advice-of-Charge messages

Definition at line 1069 of file res_pjsip.h.

◆ stir_shaken

unsigned int stir_shaken

Set which STIR/SHAKEN behaviors we want on this endpoint

Definition at line 1057 of file res_pjsip.h.

Referenced by stir_shaken_handler().

◆ stir_shaken_profile

const ast_string_field stir_shaken_profile

Definition at line 987 of file res_pjsip.h.

◆ subscription

◆ suppress_moh_on_sendonly

int suppress_moh_on_sendonly

Ignore remote hold requests

Definition at line 1073 of file res_pjsip.h.

◆ suppress_q850_reason_headers

unsigned int suppress_q850_reason_headers

Suppress Q.850 Reason headers on this endpoint

Definition at line 1049 of file res_pjsip.h.

◆ transport

const ast_string_field transport

◆ usereqphone

unsigned int usereqphone

Whether to place a 'user=phone' parameter into the request URI if user is a number

Definition at line 1027 of file res_pjsip.h.

Referenced by ast_sip_add_usereqphone().

◆ zone

const ast_string_field zone

Definition at line 987 of file res_pjsip.h.


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