Files
asterisk/res/res_pjsip/include/res_pjsip_private.h
Joshua Colp bb982480d8 pjsip: Support dual stack automatically.
This change adds support for dual stack automatically. No
configuration is required and the IP address and version
in the SIP messages and SDP will be automatically changed
based on the transport over which the message is being
sent. RTP usage has also been changed to listen on both
IPv4 and IPv6 simultaneously to allow media to flow, and
to allow ICE support on both simultaneously. This also
allows failover between IPv6 and IPv4 to work as expected.

ASTERISK-26309 #close

Change-Id: I235a421d8f9a326606d861b449fa6fe3a030572d
2016-10-23 13:51:42 +00:00

362 lines
7.7 KiB
C

/*
* res_pjsip_private.h
*
* Created on: Jan 25, 2013
* Author: mjordan
*/
#ifndef RES_PJSIP_PRIVATE_H_
#define RES_PJSIP_PRIVATE_H_
/*!
* \todo XXX Functions prototyped in this file that begin with "ast_sip_"
* need to be renamed so res_pjsip.so does not export the names outside
* of the module.
*/
#include "asterisk/module.h"
#include "asterisk/compat.h"
struct ao2_container;
struct ast_threadpool_options;
struct ast_sip_cli_context;
/*!
* \internal
* \brief Initialize the configuration for res_pjsip
*/
int ast_res_pjsip_initialize_configuration(const struct ast_module_info *ast_module_info);
/*!
* \internal
* \brief Annihilate the configuration objects
*/
void ast_res_pjsip_destroy_configuration(void);
/*!
* \internal
* \brief Reload the configuration
*/
int ast_res_pjsip_reload_configuration(void);
/*!
* \internal
* \brief Initialize transport support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_sorcery_transport(void);
/*!
* \internal
* \brief Destroy transport support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_destroy_sorcery_transport(void);
/*!
* \internal
* \brief Initialize qualify support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_sorcery_qualify(void);
/*!
* \internal
* \brief Initialize location support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_sorcery_location(void);
/*!
* \internal
* \brief Destroy location support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_destroy_sorcery_location(void);
/*!
* \internal
* \brief Initialize domain aliases support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_sorcery_domain_alias(void);
/*!
* \internal
* \brief Initialize authentication support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_sorcery_auth(void);
/*!
* \internal
* \brief Destroy authentication support on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_destroy_sorcery_auth(void);
/*!
* \internal
* \brief Initialize the distributor module
*
* The distributor module is responsible for taking an incoming
* SIP message and placing it into the threadpool. Once in the threadpool,
* the distributor will perform endpoint lookups and authentication, and
* then distribute the message up the stack to any further modules.
*
* \retval -1 Failure
* \retval 0 Success
*/
int ast_sip_initialize_distributor(void);
/*!
* \internal
* \brief Destruct the distributor module.
*
* Unregisters pjsip modules and cleans up any allocated resources.
*/
void ast_sip_destroy_distributor(void);
/*!
* \internal
* \brief Initialize global type on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_sorcery_global(void);
/*!
* \internal
* \brief Destroy global type on a sorcery instance
* \since 13.3.0
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_destroy_sorcery_global(void);
/*!
* \internal
* \brief Initialize global headers support
*
* \return Nothing
*/
void ast_sip_initialize_global_headers(void);
/*!
* \internal
* \brief Destroy global headers support
*
* \return Nothing
*/
void ast_sip_destroy_global_headers(void);
/*!
* \internal
* \brief Initialize OPTIONS request handling.
*
* XXX This currently includes qualifying peers. It shouldn't.
* That should go into a registrar. When that occurs, we won't
* need the reload stuff.
*
* \param reload Reload options handling
*
* \retval 0 on success
* \retval other on failure
*/
int ast_res_pjsip_init_options_handling(int reload);
/*!
* \internal Initialize message IP updating handling.
*
* \retval 0 on success
* \retval other on failure
*/
int ast_res_pjsip_init_message_ip_updater(void);
/*!
* \internal
* \brief Initialize transport storage for contacts.
*
* \retval 0 on success
* \retval other on failure
*/
int ast_res_pjsip_init_contact_transports(void);
/*!
* \internal
* \brief Initialize outbound authentication support
*
* \retval 0 Success
* \retval non-zero Failure
*/
int internal_sip_initialize_outbound_authentication(void);
/*!
* \internal
* \brief Destroy outbound authentication support
*
* \retval 0 Success
* \retval non-zero Failure
*/
void internal_sip_destroy_outbound_authentication(void);
/*!
* \internal
* \brief Initialize system configuration
*
* \retval 0 Success
* \retval non-zero Failure
*/
int ast_sip_initialize_system(void);
/*!
* \internal
* \brief Destroy system configuration
*/
void ast_sip_destroy_system(void);
/*!
* \internal
* \brief Initialize nameserver configuration
*/
void ast_sip_initialize_dns(void);
/*!
* \internal
* \brief Initialize global configuration
*
* \retval 0 Success
* \retval non-zero Failure
*/
int ast_sip_initialize_global(void);
/*!
* \internal
* \brief Clean up res_pjsip options handling
*/
void ast_res_pjsip_cleanup_options_handling(void);
/*!
* \internal
* \brief Clean up res_pjsip message ip updating handling
*/
void ast_res_pjsip_cleanup_message_ip_updater(void);
/*!
* \internal
* \brief Get threadpool options
*/
void sip_get_threadpool_options(struct ast_threadpool_options *threadpool_options);
/*!
* \internal
* \brief Retrieve the name of the default outbound endpoint.
*
* \note This returns a memory allocated copy of the name that
* needs to be freed by the caller.
*
* \retval The name of the default outbound endpoint.
* \retval NULL if configuration not found.
*/
char *ast_sip_global_default_outbound_endpoint(void);
/*!
* \internal
* \brief Functions for initializing and destroying the CLI.
*/
int ast_sip_initialize_cli(void);
void ast_sip_destroy_cli(void);
/*!
* \internal
* \brief Add res_pjsip global configuration options to the cli context.
*
* \param context context to add options to
* \retval 0 Success, -1 on failure
*/
int sip_cli_print_global(struct ast_sip_cli_context *context);
/*!
* \internal
* \brief Add res_pjsip system configuration options to the cli context.
*
* \param context context to add options to
* \retval 0 Success, -1 on failure
*/
int sip_cli_print_system(struct ast_sip_cli_context *context);
/*!
* \internal
* \brief Used by res_pjsip.so to register a service without adding a self reference
*/
int internal_sip_register_service(pjsip_module *module);
/*!
* \internal
* \brief Used by res_pjsip.so to unregister a service without removing a self reference
*/
int internal_sip_unregister_service(pjsip_module *module);
/*!
* \internal
* \brief Used by res_pjsip.so to register an endpoint formatter without adding a self reference
*/
void internal_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
/*!
* \internal
* \brief Used by res_pjsip.so to unregister a endpoint formatter without removing a self reference
*/
int internal_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
/*!
* \internal
* \brief Finds or creates contact_status for a contact
*/
struct ast_sip_contact_status *ast_res_pjsip_find_or_create_contact_status(const struct ast_sip_contact *contact);
/*!
* \internal
* \brief Validate that the uri meets pjproject length restrictions
*/
int ast_sip_validate_uri_length(const char *uri);
/*!
* \brief Initialize scheduler
* \since 13.9.0
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_scheduler(void);
/*!
* \internal
* \brief Destroy scheduler
* \since 13.9.0
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_destroy_scheduler(void);
#endif /* RES_PJSIP_PRIVATE_H_ */