WARNING: The online documentation has moved to https://docs.pjsip.org.

Visit the new documentation at https://docs.pjsip.org:

BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJSIP Reference

#include <pjsua.h>

Data Fields

unsigned port
 
unsigned port_range
 
pj_bool_t randomize_port
 
pj_str_t public_addr
 
pj_str_t bound_addr
 
pjsip_tls_setting tls_setting
 
pj_qos_type qos_type
 
pj_qos_params qos_params
 
pj_sockopt_params sockopt_params
 

Detailed Description

Transport configuration for creating transports for both SIP and media. Before setting some values to this structure, application MUST call pjsua_transport_config_default() to initialize its values with default settings.

Field Documentation

◆ port

unsigned pjsua_transport_config::port

UDP port number to bind locally. This setting MUST be specified even when default port is desired. If the value is zero, the transport will be bound to any available port, and application can query the port by querying the transport info.

◆ port_range

unsigned pjsua_transport_config::port_range

Specify the port range for socket binding, relative to the start port number specified in port. Note that this setting is only applicable to media transport when the start port number is non zero. Media transport is configurable via account setting, i.e: pjsua_acc_config.rtp_cfg, please check the media transport config docs for more info.

Available ports are in the range of [port, port + port_range].

Default value is zero.

◆ randomize_port

pj_bool_t pjsua_transport_config::randomize_port

Specify whether to randomly pick the starting port number from the range of [port, port + port_range]. This setting is used only if both port and port_range are non-zero, and only applicable for the port selection of UDP and loop media transport.

Default is PJ_FALSE.

◆ public_addr

pj_str_t pjsua_transport_config::public_addr

Optional address to advertise as the address of this transport. Application can specify any address or hostname for this field, for example it can point to one of the interface address in the system, or it can point to the public address of a NAT router where port mappings have been configured for the application.

Note: this option can be used for both UDP and TCP as well!

◆ bound_addr

pj_str_t pjsua_transport_config::bound_addr

Optional address where the socket should be bound to. This option SHOULD only be used to selectively bind the socket to particular interface (instead of 0.0.0.0), and SHOULD NOT be used to set the published address of a transport (the public_addr field should be used for that purpose).

Note that unlike public_addr field, the address (or hostname) here MUST correspond to the actual interface address in the host, since this address will be specified as bind() argument.

◆ tls_setting

pjsip_tls_setting pjsua_transport_config::tls_setting

This specifies TLS settings for TLS transport. It is only be used when this transport config is being used to create a SIP TLS transport.

◆ qos_type

pj_qos_type pjsua_transport_config::qos_type

QoS traffic type to be set on this transport. When application wants to apply QoS tagging to the transport, it's preferable to set this field rather than qos_param fields since this is more portable.

Default is QoS not set.

◆ qos_params

pj_qos_params pjsua_transport_config::qos_params

Set the low level QoS parameters to the transport. This is a lower level operation than setting the qos_type field and may not be supported on all platforms.

Default is QoS not set.

◆ sockopt_params

pj_sockopt_params pjsua_transport_config::sockopt_params

Specify options to be set on the transport.

By default there is no options.


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

 


PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
Copyright (C) 2006-2008 Teluu Inc.