.TH "eX_setup.h" 3 "Thu Dec 15 2016" "Version 4.1.0" "libeXosip2" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eX_setup.h \- eXosip setup API  

.SH SYNOPSIS
.br
.PP
\fC#include <eXosip2/eXosip\&.h>\fP
.br
\fC#include <osipparser2/osip_message\&.h>\fP
.br
\fC#include <time\&.h>\fP
.br

.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBeXosip_dns_cache\fP"
.br
.ti -1c
.RI "struct \fBeXosip_tls_credentials_s\fP"
.br
.ti -1c
.RI "struct \fBeXosip_tls_ctx_s\fP"
.br
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBEXOSIP_OPT_UDP_KEEP_ALIVE\fP   (EXOSIP_OPT_BASE_OPTION+1)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_UDP_LEARN_PORT\fP   (EXOSIP_OPT_BASE_OPTION+2)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_USE_RPORT\fP   (EXOSIP_OPT_BASE_OPTION+7)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_IPV4_FOR_GATEWAY\fP   (EXOSIP_OPT_BASE_OPTION+8)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_ADD_DNS_CACHE\fP   (EXOSIP_OPT_BASE_OPTION+9)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_DELETE_DNS_CACHE\fP   (EXOSIP_OPT_BASE_OPTION+10)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_IPV6_FOR_GATEWAY\fP   (EXOSIP_OPT_BASE_OPTION+12)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_ADD_ACCOUNT_INFO\fP   (EXOSIP_OPT_BASE_OPTION+13)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_DNS_CAPABILITIES\fP   (EXOSIP_OPT_BASE_OPTION+14)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_DSCP\fP   (EXOSIP_OPT_BASE_OPTION+15)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_REGISTER_WITH_DATE\fP   (EXOSIP_OPT_BASE_OPTION+16)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_HEADER_USER_AGENT\fP   (EXOSIP_OPT_BASE_OPTION+17)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_ENABLE_DNS_CACHE\fP   (EXOSIP_OPT_BASE_OPTION+18)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_ENABLE_AUTOANSWERBYE\fP   (EXOSIP_OPT_BASE_OPTION+19)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_ENABLE_IPV6\fP   (EXOSIP_OPT_BASE_OPTION+20)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_TLS_VERIFY_CERTIFICATE\fP   (EXOSIP_OPT_BASE_OPTION+500)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_TLS_CERTIFICATES_INFO\fP   (EXOSIP_OPT_BASE_OPTION+501)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_TLS_CLIENT_CERTIFICATE_NAME\fP   (EXOSIP_OPT_BASE_OPTION+502)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_TLS_SERVER_CERTIFICATE_NAME\fP   (EXOSIP_OPT_BASE_OPTION+503)"
.br
.ti -1c
.RI "#define \fBEXOSIP_OPT_SET_TSC_SERVER\fP   (EXOSIP_OPT_BASE_OPTION+1001)"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBeXosip_tls_ctx_error\fP { \fBTLS_OK\fP = 0, \fBTLS_ERR_NO_RAND\fP = -1, \fBTLS_ERR_NO_DH_PARAM\fP = -2, \fBTLS_ERR_NO_PW\fP = -3, \fBTLS_ERR_NO_ROOT_CA\fP = -4, \fBTLS_ERR_MISSING_AUTH_PART\fP = -5 }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "struct eXosip_t * \fBeXosip_malloc\fP (void)"
.br
.ti -1c
.RI "int \fBeXosip_init\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "void \fBeXosip_quit\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "int \fBeXosip_lock\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "int \fBeXosip_unlock\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "int \fBeXosip_execute\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "int \fBeXosip_set_option\fP (struct eXosip_t *excontext, int opt, const void *value)"
.br
.ti -1c
.RI "struct osip_naptr * \fBeXosip_dnsutils_naptr\fP (struct eXosip_t *excontext, const char *domain, const char *protocol, const char *transport, int keep_in_cache)"
.br
.ti -1c
.RI "int \fBeXosip_dnsutils_dns_process\fP (struct osip_naptr *output_record, int force)"
.br
.ti -1c
.RI "int \fBeXosip_dnsutils_rotate_srv\fP (struct osip_srv_record *output_record)"
.br
.ti -1c
.RI "int \fBeXosip_listen_addr\fP (struct eXosip_t *excontext, int transport, const char *addr, int port, int family, int secure)"
.br
.ti -1c
.RI "int \fBeXosip_reset_transports\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "int \fBeXosip_set_socket\fP (struct eXosip_t *excontext, int transport, int socket, int port)"
.br
.ti -1c
.RI "void \fBeXosip_set_user_agent\fP (struct eXosip_t *excontext, const char *user_agent)"
.br
.ti -1c
.RI "const char * \fBeXosip_get_version\fP (void)"
.br
.ti -1c
.RI "int \fBeXosip_set_cbsip_message\fP (struct eXosip_t *excontext, CbSipCallback cbsipCallback)"
.br
.ti -1c
.RI "void \fBeXosip_enable_ipv6\fP (int ipv6_enable)"
.br
.ti -1c
.RI "void \fBeXosip_masquerade_contact\fP (struct eXosip_t *excontext, const char *public_address, int port)"
.br
.ti -1c
.RI "int \fBeXosip_find_free_port\fP (struct eXosip_t *excontext, int free_port, int transport)"
.br
.ti -1c
.RI "int \fBeXosip_transport_set\fP (osip_message_t *msg, const char *transport)"
.br
.ti -1c
.RI "int \fBeXosip_guess_localip\fP (struct eXosip_t *excontext, int family, char *address, int size)"
.br
.in -1c
.SH "Detailed Description"
.PP 
eXosip setup API 

This file provide the API needed to setup and configure the SIP endpoint\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for libeXosip2 from the source code\&.