/usr/include/pjsip/sip_transport_udp.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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 | /* $Id: sip_transport_udp.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_UDP_H__
#define __PJSIP_TRANSPORT_UDP_H__
/**
* @file sip_transport_udp.h
* @brief SIP UDP Transport.
*/
#include <pjsip/sip_transport.h>
#include <pj/sock_qos.h>
PJ_BEGIN_DECL
/**
* @defgroup PJSIP_TRANSPORT_UDP UDP Transport
* @ingroup PJSIP_TRANSPORT
* @brief API to create and register UDP transport.
* @{
* The functions below are used to create UDP transport and register
* the transport to the framework.
*/
/**
* Flag that can be specified when calling #pjsip_udp_transport_pause() or
* #pjsip_udp_transport_restart().
*/
enum
{
/**
* This flag tells the transport to keep the existing/internal socket
* handle.
*/
PJSIP_UDP_TRANSPORT_KEEP_SOCKET = 1,
/**
* This flag tells the transport to destroy the existing/internal socket
* handle. Naturally this flag and PJSIP_UDP_TRANSPORT_KEEP_SOCKET are
* mutually exclusive.
*/
PJSIP_UDP_TRANSPORT_DESTROY_SOCKET = 2
};
/**
* Settings to be specified when creating the UDP transport. Application
* should initialize this structure with its default values by calling
* pjsip_udp_transport_cfg_default().
*/
typedef struct pjsip_udp_transport_cfg
{
/**
* Address family to use. Valid values are pj_AF_INET() and
* pj_AF_INET6(). Default is pj_AF_INET().
*/
int af;
/**
* Address to bind the socket to.
*/
pj_sockaddr bind_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_udp_transport_cfg;
/**
* Initialize pjsip_udp_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_udp_transport_cfg_default(pjsip_udp_transport_cfg *cfg,
int af);
/**
* Start UDP IPv4/IPv6 transport.
*
* @param endpt The SIP endpoint.
* @param cfg UDP transport settings. Application should initialize
* this setting with #pjsip_udp_transport_cfg_default().
* @param p_transport Pointer to receive the transport.
*
* @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_udp_transport_start2(
pjsip_endpoint *endpt,
const pjsip_udp_transport_cfg *cfg,
pjsip_transport **p_transport);
/**
* Start UDP transport.
*
* @param endpt The SIP endpoint.
* @param local Optional local address to bind. If this argument
* is NULL, the UDP transport will be bound to arbitrary
* UDP port.
* @param a_name Published address (only the host and port portion is
* used). If this argument is NULL, then the bound address
* will be used as the published address.
* @param async_cnt Number of simultaneous async operations.
* @param p_transport Pointer to receive the transport.
*
* @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_udp_transport_start(pjsip_endpoint *endpt,
const pj_sockaddr_in *local,
const pjsip_host_port *a_name,
unsigned async_cnt,
pjsip_transport **p_transport);
/**
* Start IPv6 UDP transport.
*/
PJ_DECL(pj_status_t) pjsip_udp_transport_start6(pjsip_endpoint *endpt,
const pj_sockaddr_in6 *local,
const pjsip_host_port *a_name,
unsigned async_cnt,
pjsip_transport **p_transport);
/**
* Attach IPv4 UDP socket as a new transport and start the transport.
*
* @param endpt The SIP endpoint.
* @param sock UDP socket to use.
* @param a_name Published address (only the host and port portion is
* used).
* @param async_cnt Number of simultaneous async operations.
* @param p_transport Pointer to receive the transport.
*
* @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_udp_transport_attach(pjsip_endpoint *endpt,
pj_sock_t sock,
const pjsip_host_port *a_name,
unsigned async_cnt,
pjsip_transport **p_transport);
/**
* Attach IPv4 or IPv6 UDP socket as a new transport and start the transport.
*
* @param endpt The SIP endpoint.
* @param type Transport type, which is PJSIP_TRANSPORT_UDP for IPv4
* or PJSIP_TRANSPORT_UDP6 for IPv6 socket.
* @param sock UDP socket to use.
* @param a_name Published address (only the host and port portion is
* used).
* @param async_cnt Number of simultaneous async operations.
* @param p_transport Pointer to receive the transport.
*
* @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_udp_transport_attach2(pjsip_endpoint *endpt,
pjsip_transport_type_e type,
pj_sock_t sock,
const pjsip_host_port *a_name,
unsigned async_cnt,
pjsip_transport **p_transport);
/**
* Retrieve the internal socket handle used by the UDP transport. Note
* that this socket normally is registered to ioqueue, so if application
* wants to make use of this socket, it should temporarily pause the
* transport.
*
* @param transport The UDP transport.
*
* @return The socket handle, or PJ_INVALID_SOCKET if no socket
* is currently being used (for example, when transport
* is being paused).
*/
PJ_DECL(pj_sock_t) pjsip_udp_transport_get_socket(pjsip_transport *transport);
/**
* Temporarily pause or shutdown the transport. When transport is being
* paused, it cannot be used by the SIP stack to send or receive SIP
* messages.
*
* Two types of operations are supported by this function:
* - to temporarily make this transport unavailable for SIP uses, but
* otherwise keep the socket handle intact. Application then can
* retrieve the socket handle with #pjsip_udp_transport_get_socket()
* and use it to send/receive application data (for example, STUN
* messages). In this case, application should specify
* PJSIP_UDP_TRANSPORT_KEEP_SOCKET when calling this function, and
* also to specify this flag when calling #pjsip_udp_transport_restart()
* later.
* - to temporarily shutdown the transport, including closing down
* the internal socket handle. This is useful for example to
* temporarily suspend the application for an indefinite period. In
* this case, application should specify PJSIP_UDP_TRANSPORT_DESTROY_SOCKET
* flag when calling this function, and specify a new socket when
* calling #pjsip_udp_transport_restart().
*
* @param transport The UDP transport.
* @param option Pause option.
*
* @return PJ_SUCCESS if transport is paused successfully,
* or the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_udp_transport_pause(pjsip_transport *transport,
unsigned option);
/**
* Restart the transport. Several operations are supported by this function:
* - if transport was made temporarily unavailable to SIP stack with
* pjsip_udp_transport_pause() and PJSIP_UDP_TRANSPORT_KEEP_SOCKET,
* application can make the transport available to the SIP stack
* again, by specifying PJSIP_UDP_TRANSPORT_KEEP_SOCKET flag here.
* - if application wants to replace the internal socket with a new
* socket, it must specify PJSIP_UDP_TRANSPORT_DESTROY_SOCKET when
* calling this function, so that the internal socket will be destroyed
* if it hasn't been closed. In this case, application has two choices
* on how to create the new socket: 1) to let the transport create
* the new socket, in this case the \a sock option should be set
* to \a PJ_INVALID_SOCKET and optionally the \a local parameter can be
* filled with the desired address and port where the new socket
* should be bound to, or 2) to specify its own socket to be used
* by this transport, by specifying a valid socket in \a sock argument
* and set the \a local argument to NULL. In both cases, application
* may specify the published address of the socket in \a a_name
* argument.
*
* @param transport The UDP transport.
* @param option Restart option.
* @param sock Optional socket to be used by the transport.
* @param local The address where the socket should be bound to.
* If this argument is NULL, socket will be bound
* to any available port.
* @param a_name Optionally specify the published address for
* this transport. If the socket is not replaced
* (PJSIP_UDP_TRANSPORT_KEEP_SOCKET flag is
* specified), then if this argument is NULL, the
* previous value will be used. If the socket is
* replaced and this argument is NULL, the bound
* address will be used as the published address
* of the transport.
*
* @return PJ_SUCCESS if transport can be restarted, or
* the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_udp_transport_restart(pjsip_transport *transport,
unsigned option,
pj_sock_t sock,
const pj_sockaddr_in *local,
const pjsip_host_port *a_name);
/**
* Restart the transport. Several operations are supported by this function:
* - if transport was made temporarily unavailable to SIP stack with
* pjsip_udp_transport_pause() and PJSIP_UDP_TRANSPORT_KEEP_SOCKET,
* application can make the transport available to the SIP stack
* again, by specifying PJSIP_UDP_TRANSPORT_KEEP_SOCKET flag here.
* - if application wants to replace the internal socket with a new
* socket, it must specify PJSIP_UDP_TRANSPORT_DESTROY_SOCKET when
* calling this function, so that the internal socket will be destroyed
* if it hasn't been closed. In this case, application has two choices
* on how to create the new socket: 1) to let the transport create
* the new socket, in this case the \a sock option should be set
* to \a PJ_INVALID_SOCKET and optionally the \a local parameter can be
* filled with the desired address and port where the new socket
* should be bound to, or 2) to specify its own socket to be used
* by this transport, by specifying a valid socket in \a sock argument
* and set the \a local argument to NULL. In both cases, application
* may specify the published address of the socket in \a a_name
* argument. This is another version of pjsip_udp_transport_restart()
* able to restart IPv6 transport.
*
* @param transport The UDP transport.
* @param option Restart option.
* @param sock Optional socket to be used by the transport.
* @param local The address where the socket should be bound to.
* If this argument is NULL, socket will be bound
* to any available port.
* @param a_name Optionally specify the published address for
* this transport. If the socket is not replaced
* (PJSIP_UDP_TRANSPORT_KEEP_SOCKET flag is
* specified), then if this argument is NULL, the
* previous value will be used. If the socket is
* replaced and this argument is NULL, the bound
* address will be used as the published address
* of the transport.
*
* @return PJ_SUCCESS if transport can be restarted, or
* the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_udp_transport_restart2(pjsip_transport *transport,
unsigned option,
pj_sock_t sock,
const pj_sockaddr *local,
const pjsip_host_port *a_name);
PJ_END_DECL
/**
* @}
*/
#endif /* __PJSIP_TRANSPORT_UDP_H__ */
|