\section{eXosip2 configuration API}
\label{group__eXosip2__conf}\index{eXosip2 configuration API@{eXosip2 configuration API}}
\subsection*{Functions}
\begin{CompactItemize}
\item 
int {\bf eXosip\_\-init} (void)
\item 
void {\bf eXosip\_\-quit} (void)
\item 
int {\bf eXosip\_\-execute} (void)
\item 
int {\bf eXosip\_\-set\_\-option} (eXosip\_\-option opt, const void $\ast$value)
\item 
int {\bf eXosip\_\-lock} (void)
\item 
int {\bf eXosip\_\-unlock} (void)
\item 
int {\bf \_\-eXosip\_\-get\_\-srv\_\-record} (struct osip\_\-srv\_\-record $\ast$record, char $\ast$domain, char $\ast$protocol)
\item 
int {\bf eXosip\_\-listen\_\-addr} (int transport, const char $\ast$addr, int port, int family, int secure)
\item 
int {\bf eXosip\_\-set\_\-socket} (int transport, int socket, int port)
\item 
void {\bf eXosip\_\-set\_\-user\_\-agent} (const char $\ast$user\_\-agent)
\item 
const char $\ast$ {\bf eXosip\_\-get\_\-version} (void)
\item 
void {\bf eXosip\_\-enable\_\-ipv6} (int ipv6\_\-enable)
\item 
void {\bf eXosip\_\-masquerade\_\-contact} (const char $\ast$public\_\-address, int port)
\item 
int {\bf eXosip\_\-find\_\-free\_\-port} (int free\_\-port, int transport)
\end{CompactItemize}


\subsection{Function Documentation}
\index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-init@{eXosip\_\-init}}
\index{eXosip\_\-init@{eXosip\_\-init}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-init}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-init (void)}\label{group__eXosip2__conf_gd4afb8e4f2ba6412f98e4cc55c0f32b8}


Initiate the eXtented oSIP library. \index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-quit@{eXosip\_\-quit}}
\index{eXosip\_\-quit@{eXosip\_\-quit}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-quit}]{\setlength{\rightskip}{0pt plus 5cm}void eXosip\_\-quit (void)}\label{group__eXosip2__conf_g03f2a9d54e88cbc36341cd2fcb91b05b}


Release ressource used by the eXtented oSIP library. \index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-execute@{eXosip\_\-execute}}
\index{eXosip\_\-execute@{eXosip\_\-execute}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-execute}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-execute (void)}\label{group__eXosip2__conf_ge0d5d2b0423a638fa085128b6912c74a}


Process (non-threaded mode ONLY) eXosip events. \index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-set\_\-option@{eXosip\_\-set\_\-option}}
\index{eXosip\_\-set\_\-option@{eXosip\_\-set\_\-option}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-set\_\-option}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-set\_\-option (eXosip\_\-option {\em opt}, \/  const void $\ast$ {\em value})}\label{group__eXosip2__conf_g27e073640caf23d00dff8218313eb234}


Set eXosip options. See eXosip\_\-option for available options.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em opt}]option to configure. \item[{\em value}]value for options. \end{description}
\end{Desc}
\index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-lock@{eXosip\_\-lock}}
\index{eXosip\_\-lock@{eXosip\_\-lock}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-lock}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-lock (void)}\label{group__eXosip2__conf_g039d93925ac6d1fdf35c68d6c6c435f5}


Lock the eXtented oSIP library. \index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-unlock@{eXosip\_\-unlock}}
\index{eXosip\_\-unlock@{eXosip\_\-unlock}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-unlock}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-unlock (void)}\label{group__eXosip2__conf_gcb362e00f0e5fb68ae53f18d846cd891}


UnLock the eXtented oSIP library. \index{eXosip2\_\-conf@{eXosip2\_\-conf}!\_\-eXosip\_\-get\_\-srv\_\-record@{\_\-eXosip\_\-get\_\-srv\_\-record}}
\index{\_\-eXosip\_\-get\_\-srv\_\-record@{\_\-eXosip\_\-get\_\-srv\_\-record}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{\_\-eXosip\_\-get\_\-srv\_\-record}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-eXosip\_\-get\_\-srv\_\-record (struct osip\_\-srv\_\-record $\ast$ {\em record}, \/  char $\ast$ {\em domain}, \/  char $\ast$ {\em protocol})}\label{group__eXosip2__conf_gddc6c1e4393a7d099933515752e749c7}


Ask for SRV record.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em record}]result structure. \item[{\em domain}]domain name for SRV record \item[{\em protocol}]protocol to use \end{description}
\end{Desc}
\index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-listen\_\-addr@{eXosip\_\-listen\_\-addr}}
\index{eXosip\_\-listen\_\-addr@{eXosip\_\-listen\_\-addr}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-listen\_\-addr}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-listen\_\-addr (int {\em transport}, \/  const char $\ast$ {\em addr}, \/  int {\em port}, \/  int {\em family}, \/  int {\em secure})}\label{group__eXosip2__conf_g4648d9560a905179aafa939caca622f5}


Listen on a specified socket.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em transport}]IPPROTO\_\-UDP for udp. (soon to come: TCP/TLS?) \item[{\em addr}]the address to bind (NULL for all interface) \item[{\em port}]the listening port. (0 for random port) \item[{\em family}]the IP family (AF\_\-INET or AF\_\-INET6). \item[{\em secure}]0 for UDP or TCP, 1 for TLS (with TCP). \end{description}
\end{Desc}
\index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-set\_\-socket@{eXosip\_\-set\_\-socket}}
\index{eXosip\_\-set\_\-socket@{eXosip\_\-set\_\-socket}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-set\_\-socket}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-set\_\-socket (int {\em transport}, \/  int {\em socket}, \/  int {\em port})}\label{group__eXosip2__conf_g53b1301ba9761255f7ec71acdb89bd74}


Listen on a specified socket.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em transport}]IPPROTO\_\-UDP for udp. (soon to come: TCP/TLS?) \item[{\em socket}]socket to use for listening to UDP sip messages. \item[{\em port}]the listening port for masquerading. \end{description}
\end{Desc}
\index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-set\_\-user\_\-agent@{eXosip\_\-set\_\-user\_\-agent}}
\index{eXosip\_\-set\_\-user\_\-agent@{eXosip\_\-set\_\-user\_\-agent}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-set\_\-user\_\-agent}]{\setlength{\rightskip}{0pt plus 5cm}void eXosip\_\-set\_\-user\_\-agent (const char $\ast$ {\em user\_\-agent})}\label{group__eXosip2__conf_gc58abf4a2579d34a3315740107790d55}


Set the SIP User-Agent: header string.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em user\_\-agent}]the User-Agent header to insert in messages. \end{description}
\end{Desc}
\index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-get\_\-version@{eXosip\_\-get\_\-version}}
\index{eXosip\_\-get\_\-version@{eXosip\_\-get\_\-version}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-get\_\-version}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ eXosip\_\-get\_\-version (void)}\label{group__eXosip2__conf_gd5a6f1ae19bfc8305a64284db5045236}


Get the eXosip version as a sring \index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-enable\_\-ipv6@{eXosip\_\-enable\_\-ipv6}}
\index{eXosip\_\-enable\_\-ipv6@{eXosip\_\-enable\_\-ipv6}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-enable\_\-ipv6}]{\setlength{\rightskip}{0pt plus 5cm}void eXosip\_\-enable\_\-ipv6 (int {\em ipv6\_\-enable})}\label{group__eXosip2__conf_gbf881c83da7f6c25e791938c18824a4e}


Use IPv6 instead of IPv4.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ipv6\_\-enable}]This paramter should be set to 1 to enable IPv6 mode. \end{description}
\end{Desc}
\index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-masquerade\_\-contact@{eXosip\_\-masquerade\_\-contact}}
\index{eXosip\_\-masquerade\_\-contact@{eXosip\_\-masquerade\_\-contact}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-masquerade\_\-contact}]{\setlength{\rightskip}{0pt plus 5cm}void eXosip\_\-masquerade\_\-contact (const char $\ast$ {\em public\_\-address}, \/  int {\em port})}\label{group__eXosip2__conf_gbd30814449260a3a69e11eaec444f245}


This method is used to replace contact address with the public address of your NAT. The ip address should be retreived manually (fixed IP address) or with STUN. This address will only be used when the remote correspondant appears to be on an DIFFERENT LAN.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em public\_\-address}]the ip address. \item[{\em port}]the port for masquerading.\end{description}
\end{Desc}
If set to NULL, then the local ip address will be guessed automatically (returns to default mode). \index{eXosip2\_\-conf@{eXosip2\_\-conf}!eXosip\_\-find\_\-free\_\-port@{eXosip\_\-find\_\-free\_\-port}}
\index{eXosip\_\-find\_\-free\_\-port@{eXosip\_\-find\_\-free\_\-port}!eXosip2_conf@{eXosip2\_\-conf}}
\subsubsection[{eXosip\_\-find\_\-free\_\-port}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-find\_\-free\_\-port (int {\em free\_\-port}, \/  int {\em transport})}\label{group__eXosip2__conf_g977e8a8567177fce827da56c27a1e2ab}


This method is used to find out an free IPPROTO\_\-UDP or IPPROTO\_\-TCP port.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em free\_\-port}]initial port for search. \item[{\em transport}]IPPROTO\_\-UDP or IPPROTO\_\-TCP protocol. \end{description}
\end{Desc}