1455 lines
55 KiB
C
1455 lines
55 KiB
C
/*
|
|
* FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
|
|
* Copyright (C) 2005/2006, Anthony Minessale II <anthmct@yahoo.com>
|
|
*
|
|
* Version: MPL 1.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Anthony Minessale II <anthmct@yahoo.com>
|
|
* Portions created by the Initial Developer are Copyright (C)
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Anthony Minessale II <anthmct@yahoo.com>
|
|
*
|
|
* switch_apr.h -- APR includes header
|
|
*
|
|
*/
|
|
/*! \file switch_apr.h
|
|
\brief APR includes header
|
|
|
|
The things powered by APR are renamed into the switch_ namespace to provide a cleaner
|
|
look to things and helps me to document what parts of APR I am using I'd like to take this
|
|
opportunity to thank APR for all the awesome stuff it does and for making my life much easier.
|
|
|
|
*/
|
|
#ifndef SWITCH_APR_H
|
|
#define SWITCH_APR_H
|
|
|
|
#include <apr.h>
|
|
#include <apr_network_io.h>
|
|
#include <apr_errno.h>
|
|
#include <apr_general.h>
|
|
#include <apr_thread_proc.h>
|
|
#include <apr_portable.h>
|
|
#include <apr_thread_mutex.h>
|
|
#include <apr_thread_cond.h>
|
|
#include <apr_thread_rwlock.h>
|
|
#include <apr_file_io.h>
|
|
#include <apr_poll.h>
|
|
#include <apr_dso.h>
|
|
#include <apr_hash.h>
|
|
#include <apr_strings.h>
|
|
#include <apr_network_io.h>
|
|
#include <apr_poll.h>
|
|
#include <apr_queue.h>
|
|
#include <apr_uuid.h>
|
|
#include <apr_strmatch.h>
|
|
#define APR_WANT_STDIO
|
|
#define APR_WANT_STRFUNC
|
|
#include <apr_want.h>
|
|
#include <apr_env.h>
|
|
|
|
SWITCH_BEGIN_EXTERN_C
|
|
|
|
/*
|
|
The pieces of apr we allow ppl to pass around between modules we typedef into our namespace and wrap all the functions
|
|
any other apr code should be as hidden as possible.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup switch_apr Brought To You By APR
|
|
* @ingroup FREESWITCH
|
|
* @{
|
|
*/
|
|
|
|
typedef apr_size_t swtich_size_t;
|
|
typedef apr_int16_t switch_int16_t;
|
|
|
|
/**
|
|
* @defgroup switch_file_io File I/O Handling Functions
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
typedef apr_size_t switch_size_t;
|
|
|
|
/** Structure for referencing files. */
|
|
typedef apr_file_t switch_file_t;
|
|
|
|
#define SWITCH_SO_LINGER APR_SO_LINGER
|
|
#define SWITCH_SO_KEEPALIVE APR_SO_KEEPALIVE
|
|
#define SWITCH_SO_DEBUG APR_SO_DEBUG
|
|
#define SWITCH_SO_NONBLOCK APR_SO_NONBLOCK
|
|
#define SWITCH_SO_REUSEADDR APR_SO_REUSEADDR
|
|
#define SWITCH_SO_SNDBUF APR_SO_SNDBUF
|
|
#define SWITCH_SO_RCVBUF APR_SO_RCVBUF
|
|
#define SWITCH_SO_DISCONNECTED APR_SO_DISCONNECTED
|
|
|
|
/**
|
|
* @defgroup switch_file_permissions File Permissions flags
|
|
* @ingroup switch_file_io
|
|
* @{
|
|
*/
|
|
|
|
#define SWITCH_FPROT_USETID APR_FPROT_USETID /**< Set user id */
|
|
#define SWITCH_FPROT_UREAD APR_FPROT_UREAD /**< Read by user */
|
|
#define SWITCH_FPROT_UWRITE APR_FPROT_UWRITE /**< Write by user */
|
|
#define SWITCH_FPROT_UEXECUTE APR_FPROT_UEXECUTE /**< Execute by user */
|
|
|
|
#define SWITCH_FPROT_GSETID APR_FPROT_GSETID /**< Set group id */
|
|
#define SWITCH_FPROT_GREAD APR_FPROT_GREAD /**< Read by group */
|
|
#define SWITCH_FPROT_GWRITE APR_FPROT_GWRITE /**< Write by group */
|
|
#define SWITCH_FPROT_GEXECUTE APR_FPROT_GEXECUTE /**< Execute by group */
|
|
|
|
#define SWITCH_FPROT_WSETID APR_FPROT_U WSETID
|
|
#define SWITCH_FPROT_WREAD APR_FPROT_WREAD /**< Read by others */
|
|
#define SWITCH_FPROT_WWRITE APR_FPROT_WWRITE /**< Write by others */
|
|
#define SWITCH_FPROT_WEXECUTE APR_FPROT_WEXECUTE /**< Execute by others */
|
|
|
|
#define SWITCH_FPROT_OS_DEFAULT APR_FPROT_OS_DEFAULT /**< use OS's default permissions */
|
|
|
|
/* additional permission flags for apr_file_copy and apr_file_append */
|
|
#define SWITCH_FPROT_FILE_SOURCE_PERMS APR_FPROT_FILE_SOURCE_PERMS /**< Copy source file's permissions */
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_file_open_flags File Open Flags/Routines
|
|
* @ingroup switch_file_io
|
|
* @{
|
|
*/
|
|
#define SWITCH_FOPEN_READ APR_FOPEN_READ /**< Open the file for reading */
|
|
#define SWITCH_FOPEN_WRITE APR_FOPEN_WRITE /**< Open the file for writing */
|
|
#define SWITCH_FOPEN_CREATE APR_FOPEN_CREATE /**< Create the file if not there */
|
|
#define SWITCH_FOPEN_APPEND APR_FOPEN_APPEND /**< Append to the end of the file */
|
|
#define SWITCH_FOPEN_TRUNCATE APR_FOPEN_TRUNCATE /**< Open the file and truncate to 0 length */
|
|
#define SWITCH_FOPEN_BINARY APR_FOPEN_BINARY /**< Open the file in binary mode */
|
|
#define SWITCH_FOPEN_EXCL APR_FOPEN_EXCL /**< Open should fail if APR_CREATE and file exists. */
|
|
#define SWITCH_FOPEN_BUFFERED APR_FOPEN_BUFFERED /**< Open the file for buffered I/O */
|
|
#define SWITCH_FOPEN_DELONCLOSE APR_FOPEN_DELONCLOSE /**< Delete the file after close */
|
|
#define SWITCH_FOPEN_XTHREAD APR_FOPEN_XTHREAD /**< Platform dependent tag to open the file for use across multiple threads */
|
|
#define SWITCH_FOPEN_SHARELOCK APR_FOPEN_SHARELOCK /**< Platform dependent support for higher level locked read/write access to support writes across process/machines */
|
|
#define SWITCH_FOPEN_NOCLEANUP APR_FOPEN_NOCLEANUP /**< Do not register a cleanup when the file is opened */
|
|
#define SWITCH_FOPEN_SENDFILE_ENABLED APR_FOPEN_SENDFILE_ENABLED /**< Advisory flag that this file should support apr_socket_sendfile operation */
|
|
#define SWITCH_FOPEN_LARGEFILE APR_FOPEN_LAREFILE /**< Platform dependent flag to enable large file support */
|
|
/** @} */
|
|
|
|
/**
|
|
* Open the specified file.
|
|
* @param newf The opened file descriptor.
|
|
* @param fname The full path to the file (using / on all systems)
|
|
* @param flag Or'ed value of:
|
|
* <PRE>
|
|
* SWITCH_FOPEN_READ open for reading
|
|
* SWITCH_FOPEN_WRITE open for writing
|
|
* SWITCH_FOPEN_CREATE create the file if not there
|
|
* SWITCH_FOPEN_APPEND file ptr is set to end prior to all writes
|
|
* SWITCH_FOPEN_TRUNCATE set length to zero if file exists
|
|
* SWITCH_FOPEN_BINARY not a text file (This flag is ignored on
|
|
* UNIX because it has no meaning)
|
|
* SWITCH_FOPEN_BUFFERED buffer the data. Default is non-buffered
|
|
* SWITCH_FOPEN_EXCL return error if APR_CREATE and file exists
|
|
* SWITCH_FOPEN_DELONCLOSE delete the file after closing.
|
|
* SWITCH_FOPEN_XTHREAD Platform dependent tag to open the file
|
|
* for use across multiple threads
|
|
* SWITCH_FOPEN_SHARELOCK Platform dependent support for higher
|
|
* level locked read/write access to support
|
|
* writes across process/machines
|
|
* SWITCH_FOPEN_NOCLEANUP Do not register a cleanup with the pool
|
|
* passed in on the <EM>pool</EM> argument (see below).
|
|
* The apr_os_file_t handle in apr_file_t will not
|
|
* be closed when the pool is destroyed.
|
|
* SWITCH_FOPEN_SENDFILE_ENABLED Open with appropriate platform semantics
|
|
* for sendfile operations. Advisory only,
|
|
* apr_socket_sendfile does not check this flag.
|
|
* </PRE>
|
|
* @param perm Access permissions for file.
|
|
* @param pool The pool to use.
|
|
* @remark If perm is SWITCH_FPROT_OS_DEFAULT and the file is being created,
|
|
* appropriate default permissions will be used.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_file_open(switch_file_t **newf, const char *fname, apr_int32_t flag, switch_fileperms_t perm, switch_pool_t *pool);)
|
|
#define switch_file_open apr_file_open
|
|
#define switch_file_seek apr_file_seek
|
|
|
|
/**
|
|
* Close the specified file.
|
|
* @param file The file descriptor to close.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_file_close(switch_file_t *file);)
|
|
#define switch_file_close apr_file_close
|
|
|
|
/**
|
|
* Read data from the specified file.
|
|
* @param thefile The file descriptor to read from.
|
|
* @param buf The buffer to store the data to.
|
|
* @param nbytes On entry, the number of bytes to read; on exit, the number
|
|
* of bytes read.
|
|
*
|
|
* @remark apr_file_read will read up to the specified number of
|
|
* bytes, but never more. If there isn't enough data to fill that
|
|
* number of bytes, all of the available data is read. The third
|
|
* argument is modified to reflect the number of bytes read. If a
|
|
* char was put back into the stream via ungetc, it will be the first
|
|
* character returned.
|
|
*
|
|
* @remark It is not possible for both bytes to be read and an APR_EOF
|
|
* or other error to be returned. APR_EINTR is never returned.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_file_read(switch_file_t *thefile, void *buf, switch_size_t *nbytes);)
|
|
#define switch_file_read apr_file_read
|
|
|
|
/**
|
|
* Write data to the specified file.
|
|
* @param thefile The file descriptor to write to.
|
|
* @param buf The buffer which contains the data.
|
|
* @param nbytes On entry, the number of bytes to write; on exit, the number
|
|
* of bytes written.
|
|
*
|
|
* @remark apr_file_write will write up to the specified number of
|
|
* bytes, but never more. If the OS cannot write that many bytes, it
|
|
* will write as many as it can. The third argument is modified to
|
|
* reflect the * number of bytes written.
|
|
*
|
|
* @remark It is possible for both bytes to be written and an error to
|
|
* be returned. APR_EINTR is never returned.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_file_write(switch_file_t *thefile, const void *buf, switch_size_t *nbytes);)
|
|
#define switch_file_write apr_file_write
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_thread_cond Condition Variable Routines
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Note: destroying a condition variable (or likewise, destroying or
|
|
* clearing the pool from which a condition variable was allocated) if
|
|
* any threads are blocked waiting on it gives undefined results.
|
|
*/
|
|
|
|
/** Opaque structure for thread condition variables */
|
|
typedef apr_thread_cond_t switch_thread_cond_t;
|
|
|
|
/**
|
|
* Create and initialize a condition variable that can be used to signal
|
|
* and schedule threads in a single process.
|
|
* @param cond the memory address where the newly created condition variable
|
|
* will be stored.
|
|
* @param pool the pool from which to allocate the mutex.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_thread_cond_create(switch_thread_cond_t **cond, switch_pool_t *pool);)
|
|
#define switch_thread_cond_create apr_thread_cond_create
|
|
|
|
typedef apr_os_thread_t switch_thread_id_t;
|
|
|
|
#define switch_thread_data_set apr_thread_data_set
|
|
#define switch_thread_data_get apr_thread_data_get
|
|
#define switch_thread_self apr_os_thread_current
|
|
|
|
/**
|
|
* Put the active calling thread to sleep until signaled to wake up. Each
|
|
* condition variable must be associated with a mutex, and that mutex must
|
|
* be locked before calling this function, or the behavior will be
|
|
* undefined. As the calling thread is put to sleep, the given mutex
|
|
* will be simultaneously released; and as this thread wakes up the lock
|
|
* is again simultaneously acquired.
|
|
* @param cond the condition variable on which to block.
|
|
* @param mutex the mutex that must be locked upon entering this function,
|
|
* is released while the thread is asleep, and is again acquired before
|
|
* returning from this function.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_thread_cond_wait(switch_thread_cond_t *cond, switch_thread_mutex_t *mutex);)
|
|
#define switch_thread_cond_wait apr_thread_cond_wait
|
|
|
|
/**
|
|
* Put the active calling thread to sleep until signaled to wake up or
|
|
* the timeout is reached. Each condition variable must be associated
|
|
* with a mutex, and that mutex must be locked before calling this
|
|
* function, or the behavior will be undefined. As the calling thread
|
|
* is put to sleep, the given mutex will be simultaneously released;
|
|
* and as this thread wakes up the lock is again simultaneously acquired.
|
|
* @param cond the condition variable on which to block.
|
|
* @param mutex the mutex that must be locked upon entering this function,
|
|
* is released while the thread is asleep, and is again acquired before
|
|
* returning from this function.
|
|
* @param timeout The amount of time in microseconds to wait. This is
|
|
* a maximum, not a minimum. If the condition is signaled, we
|
|
* will wake up before this time, otherwise the error APR_TIMEUP
|
|
* is returned.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_thread_cond_timedwait(switch_thread_cond_t *cond, switch_thread_mutex_t *mutex, switch_interval_time_t timeout);)
|
|
#define switch_thread_cond_timedwait apr_thread_cond_timedwait
|
|
|
|
/**
|
|
* Signals a single thread, if one exists, that is blocking on the given
|
|
* condition variable. That thread is then scheduled to wake up and acquire
|
|
* the associated mutex. Although it is not required, if predictable scheduling
|
|
* is desired, that mutex must be locked while calling this function.
|
|
* @param cond the condition variable on which to produce the signal.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_thread_cond_signal(switch_thread_cond_t *cond);)
|
|
#define switch_thread_cond_signal apr_thread_cond_signal
|
|
|
|
/**
|
|
* Signals all threads blocking on the given condition variable.
|
|
* Each thread that was signaled is then scheduled to wake up and acquire
|
|
* the associated mutex. This will happen in a serialized manner.
|
|
* @param cond the condition variable on which to produce the broadcast.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_thread_cond_broadcast(switch_thread_cond_t *cond);)
|
|
#define switch_thread_cond_broadcast apr_thread_cond_broadcast
|
|
|
|
/**
|
|
* Destroy the condition variable and free the associated memory.
|
|
* @param cond the condition variable to destroy.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_thread_cond_destroy(switch_thread_cond_t *cond);)
|
|
#define switch_thread_cond_destroy apr_thread_cond_destroy
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_thread_proc Threads and Process Functions
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** Opaque Thread structure. */
|
|
typedef apr_thread_t switch_thread_t;
|
|
|
|
/** Opaque Thread attributes structure. */
|
|
typedef apr_threadattr_t switch_threadattr_t;
|
|
|
|
/**
|
|
* The prototype for any APR thread worker functions.
|
|
* typedef void *(SWITCH_THREAD_FUNC *switch_thread_start_t)(switch_thread_t*, void*);
|
|
*/
|
|
#define SWITCH_THREAD_FUNC APR_THREAD_FUNC
|
|
typedef apr_thread_start_t switch_thread_start_t;
|
|
|
|
#define switch_threadattr_stacksize_set apr_threadattr_stacksize_set
|
|
|
|
/**
|
|
* Create and initialize a new threadattr variable
|
|
* @param new_attr The newly created threadattr.
|
|
* @param cont The pool to use
|
|
*/
|
|
DoxyDefine(apr_status_t switch_threadattr_create(switch_threadattr_t **new_attr, switch_pool_t *cont);)
|
|
#define switch_threadattr_create apr_threadattr_create
|
|
|
|
/**
|
|
* Set if newly created threads should be created in detached state.
|
|
* @param attr The threadattr to affect
|
|
* @param on Non-zero if detached threads should be created.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_threadattr_detach_set(switch_threadattr_t *attr, switch_int32_t on);)
|
|
#define switch_threadattr_detach_set apr_threadattr_detach_set
|
|
|
|
/**
|
|
* Create a new thread of execution
|
|
* @param new_thread The newly created thread handle.
|
|
* @param attr The threadattr to use to determine how to create the thread
|
|
* @param func The function to start the new thread in
|
|
* @param data Any data to be passed to the starting function
|
|
* @param cont The pool to use
|
|
*/
|
|
DoxyDefine(apr_status_t switch_thread_create(switch_thread_t **new_thread, switch_threadattr_t *attr, switch_thread_start_t func, void *data, switch_pool_t *cont);)
|
|
#define switch_thread_create apr_thread_create
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_network_io Network Routines
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** descriptor refers to a socket */
|
|
#define SWITCH_POLL_SOCKET APR_POLL_SOCKET
|
|
|
|
/** @def SWITCH_UNSPEC
|
|
* Let the system decide which address family to use
|
|
*/
|
|
#define SWITCH_UNSPEC APR_UNSPEC
|
|
|
|
/** A structure to represent sockets */
|
|
typedef apr_socket_t switch_socket_t;
|
|
|
|
/** Freeswitch's socket address type, used to ensure protocol independence */
|
|
typedef apr_sockaddr_t switch_sockaddr_t;
|
|
|
|
typedef apr_port_t switch_port_t;
|
|
/* function definitions */
|
|
|
|
/**
|
|
* Create a socket.
|
|
* @param new_sock The new socket that has been set up.
|
|
* @param family The address family of the socket (e.g., APR_INET).
|
|
* @param type The type of the socket (e.g., SOCK_STREAM).
|
|
* @param protocol The protocol of the socket (e.g., APR_PROTO_TCP).
|
|
* @param cont The pool to use
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_create(switch_socket_t **new_sock, int family, int type, int protocol, switch_pool_t *cont);)
|
|
#define switch_socket_create apr_socket_create
|
|
|
|
/**
|
|
* Shutdown either reading, writing, or both sides of a socket.
|
|
* @param thesocket The socket to close
|
|
* @param how How to shutdown the socket. One of:
|
|
* <PRE>
|
|
* APR_SHUTDOWN_READ no longer allow read requests
|
|
* APR_SHUTDOWN_WRITE no longer allow write requests
|
|
* APR_SHUTDOWN_READWRITE no longer allow read or write requests
|
|
* </PRE>
|
|
* @see apr_shutdown_how_e
|
|
* @remark This does not actually close the socket descriptor, it just
|
|
* controls which calls are still valid on the socket.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_shutdown(switch_socket_t *thesocket, switch_shutdown_how_e how);)
|
|
#define switch_socket_shutdown apr_socket_shutdown
|
|
|
|
/**
|
|
* Close a socket.
|
|
* @param thesocket The socket to close
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_close(switch_socket_t *thesocket);)
|
|
#define switch_socket_close apr_socket_close
|
|
|
|
/**
|
|
* Bind the socket to its associated port
|
|
* @param sock The socket to bind
|
|
* @param sa The socket address to bind to
|
|
* @remark This may be where we will find out if there is any other process
|
|
* using the selected port.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_bind(switch_socket_t *sock, switch_sockaddr_t *sa);)
|
|
#define switch_socket_bind apr_socket_bind
|
|
|
|
/**
|
|
* Listen to a bound socket for connections.
|
|
* @param sock The socket to listen on
|
|
* @param backlog The number of outstanding connections allowed in the sockets
|
|
* listen queue. If this value is less than zero, the listen
|
|
* queue size is set to zero.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_listen(switch_socket_t *sock, switch_int32_t backlog);)
|
|
#define switch_socket_listen apr_socket_listen
|
|
|
|
/**
|
|
* Accept a new connection request
|
|
* @param new_sock A copy of the socket that is connected to the socket that
|
|
* made the connection request. This is the socket which should
|
|
* be used for all future communication.
|
|
* @param sock The socket we are listening on.
|
|
* @param connection_pool The pool for the new socket.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_accept(switch_socket_t **new_sock, switch_socket_t *sock, switch_pool_t *connection_pool);)
|
|
#define switch_socket_accept apr_socket_accept
|
|
|
|
/**
|
|
* Issue a connection request to a socket either on the same machine
|
|
* or a different one.
|
|
* @param sock The socket we wish to use for our side of the connection
|
|
* @param sa The address of the machine we wish to connect to.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_connect(switch_socket_t *sock, switch_sockaddr_t *sa);)
|
|
#define switch_socket_connect apr_socket_connect
|
|
|
|
/**
|
|
* Create apr_sockaddr_t from hostname, address family, and port.
|
|
* @param sa The new apr_sockaddr_t.
|
|
* @param hostname The hostname or numeric address string to resolve/parse, or
|
|
* NULL to build an address that corresponds to 0.0.0.0 or ::
|
|
* @param family The address family to use, or APR_UNSPEC if the system should
|
|
* decide.
|
|
* @param port The port number.
|
|
* @param flags Special processing flags:
|
|
* <PRE>
|
|
* APR_IPV4_ADDR_OK first query for IPv4 addresses; only look
|
|
* for IPv6 addresses if the first query failed;
|
|
* only valid if family is APR_UNSPEC and hostname
|
|
* isn't NULL; mutually exclusive with
|
|
* APR_IPV6_ADDR_OK
|
|
* APR_IPV6_ADDR_OK first query for IPv6 addresses; only look
|
|
* for IPv4 addresses if the first query failed;
|
|
* only valid if family is APR_UNSPEC and hostname
|
|
* isn't NULL and APR_HAVE_IPV6; mutually exclusive
|
|
* with APR_IPV4_ADDR_OK
|
|
* </PRE>
|
|
* @param p The pool for the apr_sockaddr_t and associated storage.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_sockaddr_info_get(switch_sockaddr_t **sa,
|
|
const char *hostname,
|
|
switch_int32_t family,
|
|
switch_port_t port,
|
|
switch_int32_t flags,
|
|
switch_pool_t *p);)
|
|
#define switch_sockaddr_info_get apr_sockaddr_info_get
|
|
|
|
/**
|
|
* Look up the host name from an apr_sockaddr_t.
|
|
* @param hostname The hostname.
|
|
* @param sa The apr_sockaddr_t.
|
|
* @param flags Special processing flags.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_getnameinfo(char **hostname,
|
|
switch_sockaddr_t *sa,
|
|
switch_int32_t flags);)
|
|
#define switch_getnameinfo apr_getnameinfo
|
|
|
|
/**
|
|
* Parse hostname/IP address with scope id and port.
|
|
*
|
|
* Any of the following strings are accepted:
|
|
* 8080 (just the port number)
|
|
* www.apache.org (just the hostname)
|
|
* www.apache.org:8080 (hostname and port number)
|
|
* [fe80::1]:80 (IPv6 numeric address string only)
|
|
* [fe80::1%eth0] (IPv6 numeric address string and scope id)
|
|
*
|
|
* Invalid strings:
|
|
* (empty string)
|
|
* [abc] (not valid IPv6 numeric address string)
|
|
* abc:65536 (invalid port number)
|
|
*
|
|
* @param addr The new buffer containing just the hostname. On output, *addr
|
|
* will be NULL if no hostname/IP address was specfied.
|
|
* @param scope_id The new buffer containing just the scope id. On output,
|
|
* *scope_id will be NULL if no scope id was specified.
|
|
* @param port The port number. On output, *port will be 0 if no port was
|
|
* specified.
|
|
* ### FIXME: 0 is a legal port (per RFC 1700). this should
|
|
* ### return something besides zero if the port is missing.
|
|
* @param str The input string to be parsed.
|
|
* @param p The pool from which *addr and *scope_id are allocated.
|
|
* @remark If scope id shouldn't be allowed, check for scope_id != NULL in
|
|
* addition to checking the return code. If addr/hostname should be
|
|
* required, check for addr == NULL in addition to checking the
|
|
* return code.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_parse_addr_port(char **addr,
|
|
char **scope_id,
|
|
switch_port_t *port,
|
|
const char *str,
|
|
switch_pool_t *p);)
|
|
#define switch_parse_addr_port apr_parse_addr_port
|
|
|
|
/**
|
|
* Get name of the current machine
|
|
* @param buf A buffer to store the hostname in.
|
|
* @param len The maximum length of the hostname that can be stored in the
|
|
* buffer provided. The suggested length is APRMAXHOSTLEN + 1.
|
|
* @param cont The pool to use.
|
|
* @remark If the buffer was not large enough, an error will be returned.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_gethostname(char *buf, int len, switch_pool_t *cont);)
|
|
#define switch_gethostname apr_gethostname
|
|
|
|
/**
|
|
* Return the data associated with the current socket
|
|
* @param data The user data associated with the socket.
|
|
* @param key The key to associate with the user data.
|
|
* @param sock The currently open socket.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_data_get(void **data, const char *key,
|
|
switch_socket_t *sock);)
|
|
#define switch_socket_data_get apr_socket_data_get
|
|
|
|
/**
|
|
* Set the data associated with the current socket.
|
|
* @param sock The currently open socket.
|
|
* @param data The user data to associate with the socket.
|
|
* @param key The key to associate with the data.
|
|
* @param cleanup The cleanup to call when the socket is destroyed.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_data_set(switch_socket_t *sock,
|
|
void *data,
|
|
const char *key,
|
|
switch_status_t (*cleanup)(void*));)
|
|
#define switch_socket_data_set apr_socket_data_set
|
|
|
|
/**
|
|
* Send data over a network.
|
|
* @param sock The socket to send the data over.
|
|
* @param buf The buffer which contains the data to be sent.
|
|
* @param len On entry, the number of bytes to send; on exit, the number
|
|
* of bytes sent.
|
|
* @remark
|
|
* <PRE>
|
|
* This functions acts like a blocking write by default. To change
|
|
* this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
|
|
* socket option.
|
|
*
|
|
* It is possible for both bytes to be sent and an error to be returned.
|
|
*
|
|
* APR_EINTR is never returned.
|
|
* </PRE>
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_send(switch_socket_t *sock,
|
|
const char *buf,
|
|
apr_size_t *len);)
|
|
#define switch_socket_send apr_socket_send
|
|
|
|
/**
|
|
* Send multiple packets of data over a network.
|
|
* @param sock The socket to send the data over.
|
|
* @param vec The array of iovec structs containing the data to send
|
|
* @param nvec The number of iovec structs in the array
|
|
* @param len Receives the number of bytes actually written
|
|
* @remark
|
|
* <PRE>
|
|
* This functions acts like a blocking write by default. To change
|
|
* this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
|
|
* socket option.
|
|
* The number of bytes actually sent is stored in argument 3.
|
|
*
|
|
* It is possible for both bytes to be sent and an error to be returned.
|
|
*
|
|
* APR_EINTR is never returned.
|
|
* </PRE>
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_sendv(switch_socket_t *sock,
|
|
const struct iovec *vec,
|
|
apr_int32_t nvec, apr_size_t *len);)
|
|
#define switch_socket_sendv apr_socket_sendv
|
|
|
|
/**
|
|
* @param sock The socket to send from
|
|
* @param where The apr_sockaddr_t describing where to send the data
|
|
* @param flags The flags to use
|
|
* @param buf The data to send
|
|
* @param len The length of the data to send
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_sendto(switcj_socket_t *sock,
|
|
apr_sockaddr_t *where,
|
|
apr_int32_t flags,
|
|
const char *buf,
|
|
apr_size_t *len);)
|
|
#define switch_socket_sendto apr_socket_sendto
|
|
|
|
/**
|
|
* @param from The apr_sockaddr_t to fill in the recipient info
|
|
* @param sock The socket to use
|
|
* @param flags The flags to use
|
|
* @param buf The buffer to use
|
|
* @param len The length of the available buffer
|
|
*
|
|
|
|
DoxyDefine(apr_status_t switch_socket_recvfrom(switch_sockaddr_t *from,
|
|
switch_socket_t *sock,
|
|
apr_int32_t flags,
|
|
char *buf,
|
|
apr_size_t *len);)
|
|
#define switch_socket_recvfrom apr_socket_recvfrom
|
|
*/
|
|
|
|
/**
|
|
* Send a file from an open file descriptor to a socket, along with
|
|
* optional headers and trailers
|
|
* @param sock The socket to which we're writing
|
|
* @param file The open file from which to read
|
|
* @param hdtr A structure containing the headers and trailers to send
|
|
* @param offset Offset into the file where we should begin writing
|
|
* @param len (input) - Number of bytes to send from the file
|
|
* (output) - Number of bytes actually sent,
|
|
* including headers, file, and trailers
|
|
* @param flags APR flags that are mapped to OS specific flags
|
|
* @remark This functions acts like a blocking write by default. To change
|
|
* this behavior, use apr_socket_timeout_set() or the
|
|
* APR_SO_NONBLOCK socket option.
|
|
* The number of bytes actually sent is stored in the len parameter.
|
|
* The offset parameter is passed by reference for no reason; its
|
|
* value will never be modified by the apr_socket_sendfile() function.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_sendfile(apr_socket_t *sock,
|
|
switch_file_t *file,
|
|
apr_hdtr_t *hdtr,
|
|
apr_off_t *offset,
|
|
apr_size_t *len,
|
|
apr_int32_t flags);)
|
|
#define switch_socket_sendfile apr_socket_sendfile
|
|
|
|
/**
|
|
* Read data from a network.
|
|
* @param sock The socket to read the data from.
|
|
* @param buf The buffer to store the data in.
|
|
* @param len On entry, the number of bytes to receive; on exit, the number
|
|
* of bytes received.
|
|
* @remark
|
|
* <PRE>
|
|
* This functions acts like a blocking read by default. To change
|
|
* this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
|
|
* socket option.
|
|
* The number of bytes actually received is stored in argument 3.
|
|
*
|
|
* It is possible for both bytes to be received and an APR_EOF or
|
|
* other error to be returned.
|
|
*
|
|
* APR_EINTR is never returned.
|
|
* </PRE>
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_recv(switch_socket_t *sock,
|
|
char *buf,
|
|
apr_size_t *len);)
|
|
#define switch_socket_recv apr_socket_recv
|
|
|
|
/**
|
|
* Setup socket options for the specified socket
|
|
* @param sock The socket to set up.
|
|
* @param opt The option we would like to configure. One of:
|
|
* <PRE>
|
|
* APR_SO_DEBUG -- turn on debugging information
|
|
* APR_SO_KEEPALIVE -- keep connections active
|
|
* APR_SO_LINGER -- lingers on close if data is present
|
|
* APR_SO_NONBLOCK -- Turns blocking on/off for socket
|
|
* When this option is enabled, use
|
|
* the APR_STATUS_IS_EAGAIN() macro to
|
|
* see if a send or receive function
|
|
* could not transfer data without
|
|
* blocking.
|
|
* APR_SO_REUSEADDR -- The rules used in validating addresses
|
|
* supplied to bind should allow reuse
|
|
* of local addresses.
|
|
* APR_SO_SNDBUF -- Set the SendBufferSize
|
|
* APR_SO_RCVBUF -- Set the ReceiveBufferSize
|
|
* </PRE>
|
|
* @param on Value for the option.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_opt_set(switch_socket_t *sock,
|
|
apr_int32_t opt,
|
|
apr_int32_t on);)
|
|
#define switch_socket_opt_set apr_socket_opt_set
|
|
|
|
/**
|
|
* Setup socket timeout for the specified socket
|
|
* @param sock The socket to set up.
|
|
* @param t Value for the timeout.
|
|
* <PRE>
|
|
* t > 0 -- read and write calls return APR_TIMEUP if specified time
|
|
* elapsess with no data read or written
|
|
* t == 0 -- read and write calls never block
|
|
* t < 0 -- read and write calls block
|
|
* </PRE>
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_timeout_set(switch_socket_t *sock,
|
|
apr_interval_time_t t);)
|
|
#define switch_socket_timeout_set apr_socket_timeout_set
|
|
|
|
/**
|
|
* Query socket options for the specified socket
|
|
* @param sock The socket to query
|
|
* @param opt The option we would like to query. One of:
|
|
* <PRE>
|
|
* APR_SO_DEBUG -- turn on debugging information
|
|
* APR_SO_KEEPALIVE -- keep connections active
|
|
* APR_SO_LINGER -- lingers on close if data is present
|
|
* APR_SO_NONBLOCK -- Turns blocking on/off for socket
|
|
* APR_SO_REUSEADDR -- The rules used in validating addresses
|
|
* supplied to bind should allow reuse
|
|
* of local addresses.
|
|
* APR_SO_SNDBUF -- Set the SendBufferSize
|
|
* APR_SO_RCVBUF -- Set the ReceiveBufferSize
|
|
* APR_SO_DISCONNECTED -- Query the disconnected state of the socket.
|
|
* (Currently only used on Windows)
|
|
* </PRE>
|
|
* @param on Socket option returned on the call.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_opt_get(switch_socket_t *sock,
|
|
apr_int32_t opt, apr_int32_t *on);)
|
|
#define switch_socket_opt_get apr_socket_opt_get
|
|
|
|
/**
|
|
* Query socket timeout for the specified socket
|
|
* @param sock The socket to query
|
|
* @param t Socket timeout returned from the query.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_timeout_get(switch_socket_t *sock,
|
|
apr_interval_time_t *t);)
|
|
#define switch_socket_timeout_get apr_socket_timeout_get
|
|
|
|
/**
|
|
* Query the specified socket if at the OOB/Urgent data mark
|
|
* @param sock The socket to query
|
|
* @param atmark Is set to true if socket is at the OOB/urgent mark,
|
|
* otherwise is set to false.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_atmark(switch_socket_t *sock,
|
|
int *atmark);)
|
|
#define switch_socket_atmark apr_socket_atmark
|
|
|
|
/**
|
|
* Return an apr_sockaddr_t from an apr_socket_t
|
|
* @param sa The returned apr_sockaddr_t.
|
|
* @param which Which interface do we want the apr_sockaddr_t for?
|
|
* @param sock The socket to use
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_addr_get(switch_sockaddr_t **sa,
|
|
apr_interface_e which,
|
|
switch_socket_t *sock);)
|
|
#define switch_socket_addr_get apr_socket_addr_get
|
|
|
|
/**
|
|
* Return the IP address (in numeric address string format) in
|
|
* an APR socket address. APR will allocate storage for the IP address
|
|
* string from the pool of the apr_sockaddr_t.
|
|
* @param addr The IP address.
|
|
* @param sockaddr The socket address to reference.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_sockaddr_ip_get(char **addr,
|
|
switch_sockaddr_t *sockaddr);)
|
|
#define switch_sockaddr_ip_get apr_sockaddr_ip_get
|
|
|
|
/**
|
|
* See if the IP addresses in two APR socket addresses are
|
|
* equivalent. Appropriate logic is present for comparing
|
|
* IPv4-mapped IPv6 addresses with IPv4 addresses.
|
|
*
|
|
* @param addr1 One of the APR socket addresses.
|
|
* @param addr2 The other APR socket address.
|
|
* @remark The return value will be non-zero if the addresses
|
|
* are equivalent.
|
|
*/
|
|
DoxyDefine(int switch_sockaddr_equal(const switch_sockaddr_t *addr1,
|
|
const switch_sockaddr_t *addr2);)
|
|
#define switch_sockaddr_equal apr_sockaddr_equal
|
|
|
|
/**
|
|
* Return the type of the socket.
|
|
* @param sock The socket to query.
|
|
* @param type The returned type (e.g., SOCK_STREAM).
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_type_get(switch_socket_t *sock,
|
|
int *type);)
|
|
#define switch_socket_type_get apr_socket_type_get
|
|
|
|
/**
|
|
* Given an switch_sockaddr_t and a service name, set the port for the service
|
|
* @param sockaddr The switch_sockaddr_t that will have its port set
|
|
* @param servname The name of the service you wish to use
|
|
*/
|
|
DoxyDefine(apr_status_t switch_getservbyname(switch_sockaddr_t *sockaddr,
|
|
const char *servname);)
|
|
#define switch_getservbyname apr_getservbyname
|
|
|
|
/**
|
|
* Build an ip-subnet representation from an IP address and optional netmask or
|
|
* number-of-bits.
|
|
* @param ipsub The new ip-subnet representation
|
|
* @param ipstr The input IP address string
|
|
* @param mask_or_numbits The input netmask or number-of-bits string, or NULL
|
|
* @param p The pool to allocate from
|
|
*/
|
|
DoxyDefine(apr_status_t switch_ipsubnet_create(apr_ipsubnet_t **ipsub,
|
|
const char *ipstr,
|
|
const char *mask_or_numbits,
|
|
switch_pool_t *p);)
|
|
#define switch_ipsubnet_create apr_ipsubnet_create
|
|
|
|
/**
|
|
* Test the IP address in an apr_sockaddr_t against a pre-built ip-subnet
|
|
* representation.
|
|
* @param ipsub The ip-subnet representation
|
|
* @param sa The socket address to test
|
|
* @return non-zero if the socket address is within the subnet, 0 otherwise
|
|
*/
|
|
DoxyDefine(int switch_ipsubnet_test(apr_ipsubnet_t *ipsub, switch_sockaddr_t *sa);)
|
|
#define switch_ipsubnet_test apr_ipsubnet_test
|
|
|
|
/**
|
|
* Return the protocol of the socket.
|
|
* @param sock The socket to query.
|
|
* @param protocol The returned protocol (e.g., APR_PROTO_TCP).
|
|
*/
|
|
DoxyDefine(apr_status_t switch_socket_protocol_get(switch_socket_t *sock,
|
|
int *protocol);)
|
|
#define switch_socket_protocol_get apr_socket_protocol_get
|
|
|
|
/**
|
|
* Join a Multicast Group
|
|
* @param sock The socket to join a multicast group
|
|
* @param join The address of the multicast group to join
|
|
* @param iface Address of the interface to use. If NULL is passed, the
|
|
* default multicast interface will be used. (OS Dependent)
|
|
* @param source Source Address to accept transmissions from (non-NULL
|
|
* implies Source-Specific Multicast)
|
|
*/
|
|
DoxyDefine(apr_status_t switch_mcast_join(switch_socket_t *sock,
|
|
switch_sockaddr_t *join,
|
|
switch_sockaddr_t *iface,
|
|
switch_sockaddr_t *source);)
|
|
#define switch_mcast_join apr_mcast_join
|
|
|
|
/**
|
|
* Leave a Multicast Group. All arguments must be the same as
|
|
* switch_mcast_join.
|
|
* @param sock The socket to leave a multicast group
|
|
* @param addr The address of the multicast group to leave
|
|
* @param iface Address of the interface to use. If NULL is passed, the
|
|
* default multicast interface will be used. (OS Dependent)
|
|
* @param source Source Address to accept transmissions from (non-NULL
|
|
* implies Source-Specific Multicast)
|
|
*/
|
|
DoxyDefine(apr_status_t switch_mcast_leave(switch_socket_t *sock,
|
|
switch_sockaddr_t *addr,
|
|
switch_sockaddr_t *iface,
|
|
switch_sockaddr_t *source);)
|
|
#define switch_mcast_leave apr_mcast_leave
|
|
|
|
/**
|
|
* Set the Multicast Time to Live (ttl) for a multicast transmission.
|
|
* @param sock The socket to set the multicast ttl
|
|
* @param ttl Time to live to Assign. 0-255, default=1
|
|
* @remark If the TTL is 0, packets will only be seen by sockets on
|
|
* the local machine, and only when multicast loopback is enabled.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_mcast_hops(switch_socket_t *sock,
|
|
apr_byte_t ttl);)
|
|
#define switch_mcast_hops apr_mcast_hops
|
|
|
|
/**
|
|
* Toggle IP Multicast Loopback
|
|
* @param sock The socket to set multicast loopback
|
|
* @param opt 0=disable, 1=enable
|
|
*/
|
|
DoxyDefine(apr_status_t switch_mcast_loopback(switch_socket_t *sock,
|
|
apr_byte_t opt);)
|
|
#define switch_mcast_loopback apr_mcast_loopback
|
|
|
|
/**
|
|
* Set the Interface to be used for outgoing Multicast Transmissions.
|
|
* @param sock The socket to set the multicast interface on
|
|
* @param iface Address of the interface to use for Multicast
|
|
*/
|
|
DoxyDefine(apr_status_t switch_mcast_interface(switch_socket_t *sock,
|
|
switch_sockaddr_t *iface);)
|
|
#define switch_mcast_interface apr_mcast_interface
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_memory_pool Memory Pool Functions
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
/** The fundamental pool type */
|
|
typedef apr_pool_t switch_memory_pool_t;
|
|
|
|
|
|
/**
|
|
* Clear all memory in the pool and run all the cleanups. This also destroys all
|
|
* subpools.
|
|
* @param p The pool to clear
|
|
* @remark This does not actually free the memory, it just allows the pool
|
|
* to re-use this memory for the next allocation.
|
|
* @see apr_pool_destroy()
|
|
*/
|
|
DoxyDefine(void switch_pool_clear(switch_memory_pool_t *p);)
|
|
#define switch_pool_clear apr_pool_clear
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup apr_poll Poll Routines
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
/** Poll descriptor set. */
|
|
typedef apr_pollfd_t switch_pollfd_t;
|
|
|
|
/** Opaque structure used for pollset API */
|
|
typedef apr_pollset_t switch_pollset_t;
|
|
|
|
/**
|
|
* Poll options
|
|
*/
|
|
#define SWITCH_POLLIN APR_POLLIN /**< Can read without blocking */
|
|
#define SWITCH_POLLPRI APR_POLLPRI /**< Priority data available */
|
|
#define SWITCH_POLLOUT APR_POLLOUT /**< Can write without blocking */
|
|
#define SWITCH_POLLERR APR_POLLERR /**< Pending error */
|
|
#define SWITCH_POLLHUP APR_POLLHUP /**< Hangup occurred */
|
|
#define SWITCH_POLLNVAL APR_POLLNVAL /**< Descriptior invalid */
|
|
|
|
/**
|
|
* Setup a pollset object
|
|
* @param pollset The pointer in which to return the newly created object
|
|
* @param size The maximum number of descriptors that this pollset can hold
|
|
* @param p The pool from which to allocate the pollset
|
|
* @param flags Optional flags to modify the operation of the pollset.
|
|
*
|
|
* @remark If flags equals APR_POLLSET_THREADSAFE, then a pollset is
|
|
* created on which it is safe to make concurrent calls to
|
|
* apr_pollset_add(), apr_pollset_remove() and apr_pollset_poll() from
|
|
* separate threads. This feature is only supported on some
|
|
* platforms; the apr_pollset_create() call will fail with
|
|
* APR_ENOTIMPL on platforms where it is not supported.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_pollset_create(switch_pollset_t **pollset,
|
|
apr_uint32_t size,
|
|
switch_memory_pool_t *p,
|
|
apr_uint32_t flags);)
|
|
#define switch_pollset_create apr_pollset_create
|
|
|
|
/**
|
|
* Add a socket or file descriptor to a pollset
|
|
* @param pollset The pollset to which to add the descriptor
|
|
* @param descriptor The descriptor to add
|
|
* @remark If you set client_data in the descriptor, that value
|
|
* will be returned in the client_data field whenever this
|
|
* descriptor is signalled in apr_pollset_poll().
|
|
* @remark If the pollset has been created with APR_POLLSET_THREADSAFE
|
|
* and thread T1 is blocked in a call to apr_pollset_poll() for
|
|
* this same pollset that is being modified via apr_pollset_add()
|
|
* in thread T2, the currently executing apr_pollset_poll() call in
|
|
* T1 will either: (1) automatically include the newly added descriptor
|
|
* in the set of descriptors it is watching or (2) return immediately
|
|
* with APR_EINTR. Option (1) is recommended, but option (2) is
|
|
* allowed for implementations where option (1) is impossible
|
|
* or impractical.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_pollset_add(switch_pollset_t *pollset,
|
|
const switch_pollfd_t *descriptor);)
|
|
#define switch_pollset_add apr_pollset_add
|
|
|
|
/**
|
|
* Poll the sockets in the poll structure
|
|
* @param aprset The poll structure we will be using.
|
|
* @param numsock The number of sockets we are polling
|
|
* @param nsds The number of sockets signalled.
|
|
* @param timeout The amount of time in microseconds to wait. This is
|
|
* a maximum, not a minimum. If a socket is signalled, we
|
|
* will wake up before this time. A negative number means
|
|
* wait until a socket is signalled.
|
|
* @remark The number of sockets signalled is returned in the third argument.
|
|
* This is a blocking call, and it will not return until either a
|
|
* socket has been signalled, or the timeout has expired.
|
|
*/
|
|
DoxyDefine(apr_status_t switch_poll(switch_pollfd_t *aprset, apr_int32_t numsock,
|
|
apr_int32_t *nsds,
|
|
apr_interval_time_t timeout);)
|
|
#define switch_poll apr_poll
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_time Time Routines
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** number of microseconds since 00:00:00 january 1, 1970 UTC */
|
|
typedef apr_time_t switch_time_t;
|
|
|
|
/** number of microseconds in the interval */
|
|
typedef apr_interval_time_t switch_interval_time_t;
|
|
|
|
/**
|
|
* a structure similar to ANSI struct tm with the following differences:
|
|
* - tm_usec isn't an ANSI field
|
|
* - tm_gmtoff isn't an ANSI field (it's a bsdism)
|
|
*/
|
|
typedef apr_time_exp_t switch_time_exp_t;
|
|
|
|
/**
|
|
* @return the current time
|
|
*/
|
|
DoxyDefine(switch_time_t switch_time_now(void);)
|
|
#define switch_time_now apr_time_now
|
|
|
|
/**
|
|
* formats the exploded time according to the format specified
|
|
* @param s string to write to
|
|
* @param retsize The length of the returned string
|
|
* @param max The maximum length of the string
|
|
* @param format The format for the time string
|
|
* @param tm The time to convert
|
|
*/
|
|
DoxyDefine(apr_status_t switch_strftime(char *s, apr_size_t *retsize,
|
|
apr_size_t max, const char *format,
|
|
switch_time_exp_t *tm);)
|
|
#define switch_strftime apr_strftime
|
|
|
|
/**
|
|
* switch_rfc822_date formats dates in the RFC822
|
|
* format in an efficient manner. It is a fixed length
|
|
* format which requires the indicated amount of storage,
|
|
* including the trailing NUL terminator.
|
|
* @param date_str String to write to.
|
|
* @param t the time to convert
|
|
*/
|
|
DoxyDefine(apr_status_t switch_rfc822_date(char *date_str, switch_time_t t);)
|
|
#define switch_rfc822_date apr_rfc822_date
|
|
|
|
/**
|
|
* convert a time to its human readable components in GMT timezone
|
|
* @param result the exploded time
|
|
* @param input the time to explode
|
|
*/
|
|
DoxyDefine(apr_status_t switch_time_exp_gmt(switch_time_exp_t *result,
|
|
switch_time_t input);)
|
|
#define switch_time_exp_gmt apr_time_exp_gmt
|
|
|
|
/**
|
|
* Convert time value from human readable format to a numeric apr_time_t
|
|
* e.g. elapsed usec since epoch
|
|
* @param result the resulting imploded time
|
|
* @param input the input exploded time
|
|
*/
|
|
DoxyDefine(apr_status_t switch_time_exp_get(switch_time_t *result,
|
|
switch_time_exp_t *input);)
|
|
#define switch_time_exp_get apr_time_exp_get
|
|
|
|
/**
|
|
* convert a time to its human readable components in local timezone
|
|
* @param result the exploded time
|
|
* @param input the time to explode
|
|
*/
|
|
DoxyDefine(apr_status_t switch_time_exp_lt(switch_time_exp_t *result,
|
|
switch_time_t input);)
|
|
#define switch_time_exp_lt apr_time_exp_lt
|
|
|
|
/**
|
|
* Sleep for the specified number of micro-seconds.
|
|
* @param t desired amount of time to sleep.
|
|
* @warning May sleep for longer than the specified time.
|
|
*/
|
|
DoxyDefine(void switch_sleep(apr_interval_time_t t);)
|
|
#define switch_sleep apr_sleep
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup apr_hash Hash Tables
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** Abstract type for hash tables. */
|
|
typedef apr_hash_t switch_hash_t;
|
|
|
|
/** Abstract type for scanning hash tables. */
|
|
typedef apr_hash_index_t switch_hash_index_t;
|
|
|
|
/**
|
|
* Start iterating over the entries in a hash table.
|
|
* @param p The pool to allocate the switch_hash_index_t iterator. If this
|
|
* pool is NULL, then an internal, non-thread-safe iterator is used.
|
|
* @param ht The hash table
|
|
* @remark There is no restriction on adding or deleting hash entries during
|
|
* an iteration (although the results may be unpredictable unless all you do
|
|
* is delete the current entry) and multiple iterations can be in
|
|
* progress at the same time.
|
|
|
|
*/
|
|
DoxyDefine(switch_hash_index_t * switch_hash_first(switch_memory_pool_t *p, switch_hash_t *ht);)
|
|
#define switch_hash_first apr_hash_first
|
|
|
|
/**
|
|
* Continue iterating over the entries in a hash table.
|
|
* @param hi The iteration state
|
|
* @return a pointer to the updated iteration state. NULL if there are no more
|
|
* entries.
|
|
*/
|
|
DoxyDefine(switch_hash_index_t * switch_hash_next(switch_hash_index_t *hi);)
|
|
#define switch_hash_next apr_hash_next
|
|
|
|
/**
|
|
* Get the current entry's details from the iteration state.
|
|
* @param hi The iteration state
|
|
* @param key Return pointer for the pointer to the key.
|
|
* @param klen Return pointer for the key length.
|
|
* @param val Return pointer for the associated value.
|
|
* @remark The return pointers should point to a variable that will be set to the
|
|
* corresponding data, or they may be NULL if the data isn't interesting.
|
|
*/
|
|
DoxyDefine(void switch_hash_this(switch_hash_index_t *hi, const void **key,
|
|
apr_ssize_t *klen, void **val);)
|
|
#define switch_hash_this apr_hash_this
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_StrMatch String matching routines
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** Precompiled search pattern */
|
|
typedef apr_strmatch_pattern switch_strmatch_pattern;
|
|
|
|
/**
|
|
* Precompile a pattern for matching using the Boyer-Moore-Horspool algorithm
|
|
* @param p The pool from which to allocate the pattern
|
|
* @param s The pattern string
|
|
* @param case_sensitive Whether the matching should be case-sensitive
|
|
* @return a pointer to the compiled pattern, or NULL if compilation fails
|
|
*/
|
|
DoxyDefine(const switch_strmatch_pattern * switch_strmatch_precompile(switch_memory_pool_t *p, const char *s, int case_sensitive);)
|
|
#define switch_strmatch_precompile apr_strmatch_precompile
|
|
|
|
/**
|
|
* Search for a precompiled pattern within a string
|
|
* @param pattern The pattern
|
|
* @param s The string in which to search for the pattern
|
|
* @param slen The length of s (excluding null terminator)
|
|
* @return A pointer to the first instance of the pattern in s, or
|
|
* NULL if not found
|
|
*/
|
|
DoxyDefine(const char * switch_strmatch(const switch_strmatch_pattern *pattern,
|
|
const char *s, apr_size_t slen);)
|
|
#define switch_strmatch apr_strmatch
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_UUID UUID Handling
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** we represent a UUID as a block of 16 bytes. */
|
|
|
|
typedef apr_uuid_t switch_uuid_t;
|
|
|
|
/** UUIDs are formatted as: 00112233-4455-6677-8899-AABBCCDDEEFF */
|
|
|
|
/**
|
|
* Format a UUID into a string, following the standard format
|
|
* @param buffer The buffer to place the formatted UUID string into. It must
|
|
* be at least APR_UUID_FORMATTED_LENGTH + 1 bytes long to hold
|
|
* the formatted UUID and a null terminator
|
|
* @param uuid The UUID to format
|
|
*/
|
|
DoxyDefine(void switch_uuid_format(char *buffer, const switch_uuid_t *uuid);)
|
|
#define switch_uuid_format apr_uuid_format
|
|
|
|
/**
|
|
* Generate and return a (new) UUID
|
|
* @param uuid The resulting UUID
|
|
*/
|
|
DoxyDefine(void switch_uuid_get(switch_uuid_t *uuid);)
|
|
#define switch_uuid_get apr_uuid_get
|
|
|
|
/**
|
|
* Parse a standard-format string into a UUID
|
|
* @param uuid The resulting UUID
|
|
* @param uuid_str The formatted UUID
|
|
*/
|
|
DoxyDefine(apr_status_t switch_uuid_parse(switch_uuid_t *uuid, const char *uuid_str);)
|
|
#define switch_uuid_parse apr_uuid_parse
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup switch_FIFO Thread Safe FIFO bounded queue
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** Opaque structure used for queue API */
|
|
typedef apr_queue_t switch_queue_t;
|
|
|
|
/**
|
|
* create a FIFO queue
|
|
* @param queue The new queue
|
|
* @param queue_capacity maximum size of the queue
|
|
* @param a pool to allocate queue from
|
|
*/
|
|
DoxyDefine(apr_status_t switch_queue_create(switch_queue_t **queue,
|
|
unsigned int queue_capacity,
|
|
switch_memory_pool_t *a);)
|
|
#define switch_queue_create apr_queue_create
|
|
|
|
/**
|
|
* interrupt all the threads blocking on this queue.
|
|
*
|
|
* @param queue the queue
|
|
*/
|
|
DoxyDefine(apr_status_t switch_queue_interrupt_all(switch_queue_t *queue);)
|
|
#define switch_queue_interrupt_all apr_queue_interrupt_all
|
|
|
|
/**
|
|
* pop/get an object from the queue, blocking if the queue is already empty
|
|
*
|
|
* @param queue the queue
|
|
* @param data the data
|
|
* @returns APR_EINTR the blocking was interrupted (try again)
|
|
* @returns APR_EOF if the queue has been terminated
|
|
* @returns APR_SUCCESS on a successfull pop
|
|
*/
|
|
DoxyDefine(apr_status_t switch_queue_pop(switch_queue_t *queue, void **data);)
|
|
#define switch_queue_pop apr_queue_pop
|
|
|
|
/**
|
|
* push/add a object to the queue, blocking if the queue is already full
|
|
*
|
|
* @param queue the queue
|
|
* @param data the data
|
|
* @returns APR_EINTR the blocking was interrupted (try again)
|
|
* @returns APR_EOF the queue has been terminated
|
|
* @returns APR_SUCCESS on a successfull push
|
|
*/
|
|
DoxyDefine(apr_status_t switch_queue_push(switch_queue_t *queue, void *data);)
|
|
#define switch_queue_push apr_queue_push
|
|
|
|
/**
|
|
* returns the size of the queue.
|
|
*
|
|
* @warning this is not threadsafe, and is intended for reporting/monitoring
|
|
* of the queue.
|
|
* @param queue the queue
|
|
* @returns the size of the queue
|
|
*/
|
|
DoxyDefine(unsigned int switch_queue_size(switch_queue_t *queue);)
|
|
#define switch_queue_size apr_queue_size
|
|
|
|
/**
|
|
* terminate all queue, sendinging a interupt to all the
|
|
* blocking threads
|
|
*
|
|
* @param queue the queue
|
|
*/
|
|
DoxyDefine(apr_status_t switch_queue_term(switch_queue_t *queue);)
|
|
#define switch_queue_term apr_queue_term
|
|
|
|
/**
|
|
* pop/get an object to the queue, returning immediatly if the queue is empty
|
|
*
|
|
* @param queue the queue
|
|
* @param data the data
|
|
* @returns APR_EINTR the blocking operation was interrupted (try again)
|
|
* @returns APR_EAGAIN the queue is empty
|
|
* @returns APR_EOF the queue has been terminated
|
|
* @returns APR_SUCCESS on a successfull push
|
|
*/
|
|
DoxyDefine(apr_status_t switch_queue_trypop(switch_queue_t *queue, void **data);)
|
|
#define switch_queue_trypop apr_queue_trypop
|
|
|
|
/**
|
|
* push/add a object to the queue, returning immediatly if the queue is full
|
|
*
|
|
* @param queue the queue
|
|
* @param data the data
|
|
* @returns APR_EINTR the blocking operation was interrupted (try again)
|
|
* @returns APR_EAGAIN the queue is full
|
|
* @returns APR_EOF the queue has been terminated
|
|
* @returns APR_SUCCESS on a successfull push
|
|
*/
|
|
DoxyDefine(apr_status_t switch_queue_trypush(switch_queue_t *queue, void *data);)
|
|
#define switch_queue_trypush apr_queue_trypush
|
|
|
|
/** @} */
|
|
|
|
|
|
typedef apr_thread_rwlock_t switch_thread_rwlock_t;
|
|
|
|
#define switch_thread_rwlock_create apr_thread_rwlock_create
|
|
#define switch_thread_rwlock_destroy apr_thread_rwlock_destroy
|
|
#define switch_thread_rwlock_pool_get apr_thread_rwlock_pool_get
|
|
#define switch_thread_rwlock_rdlock apr_thread_rwlock_rdlock
|
|
#define switch_thread_rwlock_tryrdlock apr_thread_rwlock_tryrdlock
|
|
#define switch_thread_rwlock_trywrlock apr_thread_rwlock_trywrlock
|
|
#define switch_thread_rwlock_unlock apr_thread_rwlock_unlock
|
|
#define switch_thread_rwlock_wrlock apr_thread_rwlock_wrlock
|
|
|
|
/**
|
|
* @defgroup switch_thread_mutex Thread Mutex Routines
|
|
* @ingroup switch_apr
|
|
* @{
|
|
*/
|
|
|
|
/** Opaque thread-local mutex structure */
|
|
typedef apr_thread_mutex_t switch_mutex_t;
|
|
|
|
/** Lock Flags */
|
|
|
|
#define SWITCH_MUTEX_DEFAULT APR_THREAD_MUTEX_DEFAULT /**< platform-optimal lock behavior */
|
|
#define SWITCH_MUTEX_NESTED APR_THREAD_MUTEX_NESTED /**< enable nested (recursive) locks */
|
|
#define SWITCH_MUTEX_UNNESTED APR_THREAD_MUTEX_UNNESTED /**< disable nested locks */
|
|
|
|
|
|
/**
|
|
* Create and initialize a mutex that can be used to synchronize threads.
|
|
* @param lock the memory address where the newly created mutex will be
|
|
* stored.
|
|
* @param flags Or'ed value of:
|
|
* <PRE>
|
|
* SWITCH_THREAD_MUTEX_DEFAULT platform-optimal lock behavior.
|
|
* SWITCH_THREAD_MUTEX_NESTED enable nested (recursive) locks.
|
|
* SWITCH_THREAD_MUTEX_UNNESTED disable nested locks (non-recursive).
|
|
* </PRE>
|
|
* @param pool the pool from which to allocate the mutex.
|
|
* @warning Be cautious in using SWITCH_THREAD_MUTEX_DEFAULT. While this is the
|
|
* most optimial mutex based on a given platform's performance charateristics,
|
|
* it will behave as either a nested or an unnested lock.
|
|
*
|
|
SWITCH_DECLARE(switch_status_t) switch_mutex_init(switch_mutex_t **lock,
|
|
switch_lock_flag flags,
|
|
switch_memory_pool_t *pool);
|
|
*/
|
|
#define switch_mutex_init apr_thread_mutex_create
|
|
/**
|
|
* Destroy the mutex and free the memory associated with the lock.
|
|
* @param lock the mutex to destroy.
|
|
*/
|
|
//SWITCH_DECLARE(switch_status_t) switch_mutex_destroy(switch_mutex_t *lock);
|
|
#define switch_mutex_destroy apr_thread_mutex_destroy
|
|
|
|
/**
|
|
* Acquire the lock for the given mutex. If the mutex is already locked,
|
|
* the current thread will be put to sleep until the lock becomes available.
|
|
* @param lock the mutex on which to acquire the lock.
|
|
*/
|
|
//SWITCH_DECLARE(switch_status_t) switch_mutex_lock(switch_mutex_t *lock);
|
|
#define switch_mutex_lock apr_thread_mutex_lock
|
|
|
|
/**
|
|
* Release the lock for the given mutex.
|
|
* @param lock the mutex from which to release the lock.
|
|
*/
|
|
//SWITCH_DECLARE(switch_status_t) switch_mutex_unlock(switch_mutex_t *lock);
|
|
#define switch_mutex_unlock apr_thread_mutex_unlock
|
|
|
|
/**
|
|
* Attempt to acquire the lock for the given mutex. If the mutex has already
|
|
* been acquired, the call returns immediately with APR_EBUSY. Note: it
|
|
* is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine
|
|
* if the return value was APR_EBUSY, for portability reasons.
|
|
* @param lock the mutex on which to attempt the lock acquiring.
|
|
*/
|
|
//SWITCH_DECLARE(switch_status_t) switch_mutex_trylock(switch_mutex_t *lock);
|
|
#define switch_mutex_trylock apr_thread_mutex_trylock
|
|
|
|
/** @} */
|
|
/** @} */
|
|
/** @} */
|
|
|
|
SWITCH_END_EXTERN_C
|
|
|
|
#endif
|
|
|
|
/* For Emacs:
|
|
* Local Variables:
|
|
* mode:c
|
|
* indent-tabs-mode:nil
|
|
* tab-width:4
|
|
* c-basic-offset:4
|
|
* End:
|
|
* For VIM:
|
|
* vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:
|
|
*/
|