Group PJSIP_TRANSPORT_TCP

group PJSIP_TRANSPORT_TCP

API to create and register TCP transport.

The functions below are used to create TCP transport and register the transport to the framework.

Functions

void pjsip_tcp_transport_cfg_default(pjsip_tcp_transport_cfg *cfg, int af)

Initialize pjsip_tcp_transport_cfg structure with default values for the specifed address family.

Parameters:

cfg – The structure to initialize.
af – Address family to be used.

pj_status_t pjsip_tcp_transport_start(pjsip_endpoint *endpt, const pj_sockaddr_in *local, unsigned async_cnt, pjsip_tpfactory **p_factory)

Register support for SIP TCP transport by creating TCP listener on the specified address and port. This function will create an instance of SIP TCP transport factory and register it to the transport manager.

Parameters:

endpt – The SIP endpoint.
local – Optional local address to bind, or specify the address to bind the server socket to. Both IP interface address and port fields are optional. If IP interface address is not specified, socket will be bound to PJ_INADDR_ANY. If port is not specified, socket will be bound to any port selected by the operating system.
async_cnt – Number of simultaneous asynchronous accept() operations to be supported. It is recommended that the number here corresponds to the number of processors in the system (or the number of SIP worker threads).
p_factory – Optional pointer to receive the instance of the SIP TCP transport factory just created.

Returns:

PJ_SUCCESS when the transport has been successfully started and registered to transport manager, or the appropriate error code.

pj_status_t pjsip_tcp_transport_start2(pjsip_endpoint *endpt, const pj_sockaddr_in *local, const pjsip_host_port *a_name, unsigned async_cnt, pjsip_tpfactory **p_factory)

A newer variant of pjsip_tcp_transport_start(), which allows specifying the published/public address of the TCP transport.

Parameters:

endpt – The SIP endpoint.
local – Optional local address to bind, or specify the address to bind the server socket to. Both IP interface address and port fields are optional. If IP interface address is not specified, socket will be bound to PJ_INADDR_ANY. If port is not specified, socket will be bound to any port selected by the operating system.
a_name – Optional published address, which is the address to be advertised as the address of this SIP transport. It can be set using IP address or hostname. If this argument is NULL, then the bound address will be used as the published address.
async_cnt – Number of simultaneous asynchronous accept() operations to be supported. It is recommended that the number here corresponds to the number of processors in the system (or the number of SIP worker threads).
p_factory – Optional pointer to receive the instance of the SIP TCP transport factory just created.

Returns:

PJ_SUCCESS when the transport has been successfully started and registered to transport manager, or the appropriate error code.

pj_status_t pjsip_tcp_transport_start3(pjsip_endpoint *endpt, const pjsip_tcp_transport_cfg *cfg, pjsip_tpfactory **p_factory)

Another variant of pjsip_tcp_transport_start().

Parameters:

endpt – The SIP endpoint.
cfg – TCP transport settings. Application should initialize this setting with pjsip_tcp_transport_cfg_default().
p_factory – Optional pointer to receive the instance of the SIP TCP transport factory just created.

Returns:

PJ_SUCCESS when the transport has been successfully started and registered to transport manager, or the appropriate error code.

pj_sock_t pjsip_tcp_transport_get_socket(pjsip_transport *transport)

Retrieve the internal socket handle used by the TCP transport. Note that this socket normally is registered to ioqueue, so application needs to take care not to perform operation that disrupts ioqueue operation.

Parameters:: transport – The TCP transport.
Returns:: The socket handle, or PJ_INVALID_SOCKET if no socket is currently being used.

pj_status_t pjsip_tcp_transport_lis_start(pjsip_tpfactory *factory, const pj_sockaddr *local, const pjsip_host_port *a_name)

Start the TCP listener, if the listener is not started yet. This is useful to start the listener manually, if listener was not started when PJSIP_TCP_TRANSPORT_DONT_CREATE_LISTENER is set to 0.

Parameters:

factory – The SIP TCP transport factory.
local – The address where the listener should be bound to. Both IP interface address and port fields are optional. If IP interface address is not specified, socket will be bound to PJ_INADDR_ANY. If port is not specified, socket will be bound to any port selected by the operating system.
a_name – The published address for the listener. It can be set using IP address or hostname. If this argument is NULL, then the bound address will be used as the published address.

Returns:

PJ_SUCCESS when the listener has been successfully started.

pj_status_t pjsip_tcp_transport_restart(pjsip_tpfactory *factory, const pj_sockaddr *local, const pjsip_host_port *a_name)

Restart the TCP listener. This will close the listener socket and recreate the socket based on the config used when starting the transport.

Parameters:

factory – The SIP TCP transport factory.
local – The address where the listener should be bound to. Both IP interface address and port fields are optional. If IP interface address is not specified, socket will be bound to PJ_INADDR_ANY. If port is not specified, socket will be bound to any port selected by the operating system.
a_name – The published address for the listener. It can be set using IP address or hostname. If this argument is NULL, then the bound address will be used as the published address.

Returns:

PJ_SUCCESS when the listener has been successfully restarted.

struct pjsip_tcp_transport_cfg

#include <sip_transport_tcp.h>

Settings to be specified when creating the TCP transport. Application should initialize this structure with its default values by calling pjsip_tcp_transport_cfg_default().

Public Members

int af: Address family to use. Valid values are pj_AF_INET() and pj_AF_INET6(). Default is pj_AF_INET().

pj_sockaddr bind_addr: Optional address to bind the socket to. Default is to bind to PJ_INADDR_ANY and to any available port.

pj_bool_t reuse_addr: Should SO_REUSEADDR be used for the listener socket. Default value is PJSIP_TCP_TRANSPORT_REUSEADDR.

pjsip_host_port addr_name: Optional published address, which is the address to be advertised as the address of this SIP transport. It can be set using IP address or hostname. By default the bound address will be used as the published address.

unsigned async_cnt

Number of simultaneous asynchronous accept() operations to be supported. It is recommended that the number here corresponds to the number of processors in the system (or the number of SIP worker threads).

Default: 1

pj_qos_type 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.

pj_qos_params 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.

pj_sockopt_params sockopt_params

Specify options to be set on the transport.

By default there is no options.

unsigned initial_timeout

Intial timeout interval to be applied to incoming transports (i.e. server side) when no valid data received after a successful connection.

Default: PJSIP_TCP_INITIAL_TIMEOUT