/usr/include/pjsip/sip_transport_tcp.h is in libpjproject-dev 2.7.2~dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | /* $Id: sip_transport_tcp.h 5649 2017-09-15 05:32:08Z riza $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJSIP_TRANSPORT_TCP_H__
#define __PJSIP_TRANSPORT_TCP_H__
/**
* @file sip_transport_tcp.h
* @brief SIP TCP Transport.
*/
#include <pjsip/sip_transport.h>
#include <pj/sock_qos.h>
/* Only declare the API if PJ_HAS_TCP is true */
#if defined(PJ_HAS_TCP) && PJ_HAS_TCP!=0
PJ_BEGIN_DECL
/**
* @defgroup PJSIP_TRANSPORT_TCP TCP Transport
* @ingroup PJSIP_TRANSPORT
* @brief API to create and register TCP transport.
* @{
* The functions below are used to create TCP transport and register
* the transport to the framework.
*/
/**
* 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().
*/
typedef struct pjsip_tcp_transport_cfg
{
/**
* Address family to use. Valid values are pj_AF_INET() and
* pj_AF_INET6(). Default is pj_AF_INET().
*/
int af;
/**
* Optional address to bind the socket to. Default is to bind to
* PJ_INADDR_ANY and to any available port.
*/
pj_sockaddr bind_addr;
/**
* Should SO_REUSEADDR be used for the listener socket.
* Default value is PJSIP_TCP_TRANSPORT_REUSEADDR.
*/
pj_bool_t reuse_addr;
/**
* Optional published address, which is the address to be
* advertised as the address of this SIP transport.
* By default the bound address will be used as the published address.
*/
pjsip_host_port addr_name;
/**
* 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
*/
unsigned async_cnt;
/**
* 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 \a qos_param fields since this is more portable.
*
* Default is QoS not set.
*/
pj_qos_type qos_type;
/**
* Set the low level QoS parameters to the transport. This is a lower
* level operation than setting the \a qos_type field and may not be
* supported on all platforms.
*
* Default is QoS not set.
*/
pj_qos_params qos_params;
/**
* Specify options to be set on the transport.
*
* By default there is no options.
*
*/
pj_sockopt_params sockopt_params;
} pjsip_tcp_transport_cfg;
/**
* Initialize pjsip_tcp_transport_cfg structure with default values for
* the specifed address family.
*
* @param cfg The structure to initialize.
* @param af Address family to be used.
*/
PJ_DECL(void) pjsip_tcp_transport_cfg_default(pjsip_tcp_transport_cfg *cfg,
int af);
/**
* 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.
*
* @param endpt The SIP endpoint.
* @param 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.
* @param 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).
* @param p_factory Optional pointer to receive the instance of the
* SIP TCP transport factory just created.
*
* @return PJ_SUCCESS when the transport has been successfully
* started and registered to transport manager, or
* the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_tcp_transport_start(pjsip_endpoint *endpt,
const pj_sockaddr_in *local,
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.
*
* @param endpt The SIP endpoint.
* @param 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.
* @param a_name Optional 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.
* @param 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).
* @param p_factory Optional pointer to receive the instance of the
* SIP TCP transport factory just created.
*
* @return PJ_SUCCESS when the transport has been successfully
* started and registered to transport manager, or
* the appropriate error code.
*/
PJ_DECL(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);
/**
* Another variant of #pjsip_tcp_transport_start().
*
* @param endpt The SIP endpoint.
* @param cfg TCP transport settings. Application should initialize
* this setting with #pjsip_tcp_transport_cfg_default().
* @param p_factory Optional pointer to receive the instance of the
* SIP TCP transport factory just created.
*
* @return PJ_SUCCESS when the transport has been successfully
* started and registered to transport manager, or
* the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_tcp_transport_start3(
pjsip_endpoint *endpt,
const pjsip_tcp_transport_cfg *cfg,
pjsip_tpfactory **p_factory
);
/**
* 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.
*
* @param transport The TCP transport.
*
* @return The socket handle, or PJ_INVALID_SOCKET if no socket
* is currently being used.
*/
PJ_DECL(pj_sock_t) pjsip_tcp_transport_get_socket(pjsip_transport *transport);
/**
* 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.
*
* @param factory The SIP TCP transport factory.
*
* @param 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.
*
* @param a_name The published address for the listener.
* If this argument is NULL, then the bound address will
* be used as the published address.
*
* @return PJ_SUCCESS when the listener has been successfully
* started.
*/
PJ_DECL(pj_status_t) pjsip_tcp_transport_lis_start(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.
*
* @param factory The SIP TCP transport factory.
*
* @param 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.
*
* @param a_name The published address for the listener.
* If this argument is NULL, then the bound address will
* be used as the published address.
*
* @return PJ_SUCCESS when the listener has been successfully
* restarted.
*
*/
PJ_DECL(pj_status_t) pjsip_tcp_transport_restart(pjsip_tpfactory *factory,
const pj_sockaddr *local,
const pjsip_host_port *a_name);
PJ_END_DECL
/**
* @}
*/
#endif /* PJ_HAS_TCP */
#endif /* __PJSIP_TRANSPORT_TCP_H__ */
|