BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

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

Data Structures

struct  pjsip_tcp_transport_cfg
 

Functions

void pjsip_tcp_transport_cfg_default (pjsip_tcp_transport_cfg *cfg, int af)
 
pj_status_t pjsip_tcp_transport_start (pjsip_endpoint *endpt, const pj_sockaddr_in *local, unsigned async_cnt, pjsip_tpfactory **p_factory)
 
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)
 
pj_status_t pjsip_tcp_transport_start3 (pjsip_endpoint *endpt, const pjsip_tcp_transport_cfg *cfg, pjsip_tpfactory **p_factory)
 
pj_sock_t pjsip_tcp_transport_get_socket (pjsip_transport *transport)
 
pj_status_t pjsip_tcp_transport_lis_start (pjsip_tpfactory *factory, const pj_sockaddr *local, const pjsip_host_port *a_name)
 
pj_status_t pjsip_tcp_transport_restart (pjsip_tpfactory *factory, const pj_sockaddr *local, const pjsip_host_port *a_name)
 

Detailed Description

Function Documentation

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
cfgThe structure to initialize.
afAddress 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
endptThe SIP endpoint.
localOptional 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_cntNumber 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_factoryOptional 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
endptThe SIP endpoint.
localOptional 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_nameOptional published address, which is the address to be advertised as the address of this SIP transport. If this argument is NULL, then the bound address will be used as the published address.
async_cntNumber 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_factoryOptional 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
endptThe SIP endpoint.
cfgTCP transport settings. Application should initialize this setting with pjsip_tcp_transport_cfg_default().
p_factoryOptional 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
transportThe 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
factoryThe SIP TCP transport factory.
localThe 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_nameThe published address for the listener. 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
factoryThe SIP TCP transport factory.
localThe 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_nameThe published address for the listener. 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.

 


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