<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libeXosip2: eXosip2 configuration API</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>eXosip2 configuration API<br>
<small>
[<a class="el" href="group__eXosip2__setup.html">General purpose API.</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#gd4afb8e4f2ba6412f98e4cc55c0f32b8">eXosip_init</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#g03f2a9d54e88cbc36341cd2fcb91b05b">eXosip_quit</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#ge0d5d2b0423a638fa085128b6912c74a">eXosip_execute</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#g27e073640caf23d00dff8218313eb234">eXosip_set_option</a> (eXosip_option opt, const void *value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#g039d93925ac6d1fdf35c68d6c6c435f5">eXosip_lock</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#gcb362e00f0e5fb68ae53f18d846cd891">eXosip_unlock</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#gddc6c1e4393a7d099933515752e749c7">_eXosip_get_srv_record</a> (struct osip_srv_record *record, char *domain, char *protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#g4648d9560a905179aafa939caca622f5">eXosip_listen_addr</a> (int transport, const char *addr, int port, int family, int secure)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#g53b1301ba9761255f7ec71acdb89bd74">eXosip_set_socket</a> (int transport, int socket, int port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#gc58abf4a2579d34a3315740107790d55">eXosip_set_user_agent</a> (const char *user_agent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#gd5a6f1ae19bfc8305a64284db5045236">eXosip_get_version</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#gbf881c83da7f6c25e791938c18824a4e">eXosip_enable_ipv6</a> (int ipv6_enable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#gbd30814449260a3a69e11eaec444f245">eXosip_masquerade_contact</a> (const char *public_address, int port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__conf.html#g977e8a8567177fce827da56c27a1e2ab">eXosip_find_free_port</a> (int free_port, int transport)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gd4afb8e4f2ba6412f98e4cc55c0f32b8"></a><!-- doxytag: member="eX_setup.h::eXosip_init" ref="gd4afb8e4f2ba6412f98e4cc55c0f32b8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initiate the eXtented oSIP library.
</div>
</div><p>
<a class="anchor" name="g03f2a9d54e88cbc36341cd2fcb91b05b"></a><!-- doxytag: member="eX_setup.h::eXosip_quit" ref="g03f2a9d54e88cbc36341cd2fcb91b05b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void eXosip_quit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release ressource used by the eXtented oSIP library.
</div>
</div><p>
<a class="anchor" name="ge0d5d2b0423a638fa085128b6912c74a"></a><!-- doxytag: member="eX_setup.h::eXosip_execute" ref="ge0d5d2b0423a638fa085128b6912c74a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_execute </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process (non-threaded mode ONLY) eXosip events.
</div>
</div><p>
<a class="anchor" name="g27e073640caf23d00dff8218313eb234"></a><!-- doxytag: member="eX_setup.h::eXosip_set_option" ref="g27e073640caf23d00dff8218313eb234" args="(eXosip_option opt, const void *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_set_option </td>
<td>(</td>
<td class="paramtype">eXosip_option </td>
<td class="paramname"> <em>opt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set eXosip options. See eXosip_option for available options.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>opt</em> </td><td>option to configure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value for options. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g039d93925ac6d1fdf35c68d6c6c435f5"></a><!-- doxytag: member="eX_setup.h::eXosip_lock" ref="g039d93925ac6d1fdf35c68d6c6c435f5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_lock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lock the eXtented oSIP library.
</div>
</div><p>
<a class="anchor" name="gcb362e00f0e5fb68ae53f18d846cd891"></a><!-- doxytag: member="eX_setup.h::eXosip_unlock" ref="gcb362e00f0e5fb68ae53f18d846cd891" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_unlock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
UnLock the eXtented oSIP library.
</div>
</div><p>
<a class="anchor" name="gddc6c1e4393a7d099933515752e749c7"></a><!-- doxytag: member="eX_setup.h::_eXosip_get_srv_record" ref="gddc6c1e4393a7d099933515752e749c7" args="(struct osip_srv_record *record, char *domain, char *protocol)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int _eXosip_get_srv_record </td>
<td>(</td>
<td class="paramtype">struct osip_srv_record * </td>
<td class="paramname"> <em>record</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>protocol</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ask for SRV record.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>record</em> </td><td>result structure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>domain</em> </td><td>domain name for SRV record </td></tr>
<tr><td valign="top"></td><td valign="top"><em>protocol</em> </td><td>protocol to use </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g4648d9560a905179aafa939caca622f5"></a><!-- doxytag: member="eX_setup.h::eXosip_listen_addr" ref="g4648d9560a905179aafa939caca622f5" args="(int transport, const char *addr, int port, int family, int secure)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_listen_addr </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>transport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>family</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>secure</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Listen on a specified socket.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>transport</em> </td><td>IPPROTO_UDP for udp. (soon to come: TCP/TLS?) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>the address to bind (NULL for all interface) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>the listening port. (0 for random port) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>family</em> </td><td>the IP family (AF_INET or AF_INET6). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>secure</em> </td><td>0 for UDP or TCP, 1 for TLS (with TCP). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g53b1301ba9761255f7ec71acdb89bd74"></a><!-- doxytag: member="eX_setup.h::eXosip_set_socket" ref="g53b1301ba9761255f7ec71acdb89bd74" args="(int transport, int socket, int port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_set_socket </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>transport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Listen on a specified socket.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>transport</em> </td><td>IPPROTO_UDP for udp. (soon to come: TCP/TLS?) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>socket</em> </td><td>socket to use for listening to UDP sip messages. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>the listening port for masquerading. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gc58abf4a2579d34a3315740107790d55"></a><!-- doxytag: member="eX_setup.h::eXosip_set_user_agent" ref="gc58abf4a2579d34a3315740107790d55" args="(const char *user_agent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void eXosip_set_user_agent </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>user_agent</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the SIP User-Agent: header string.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>user_agent</em> </td><td>the User-Agent header to insert in messages. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gd5a6f1ae19bfc8305a64284db5045236"></a><!-- doxytag: member="eX_setup.h::eXosip_get_version" ref="gd5a6f1ae19bfc8305a64284db5045236" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* eXosip_get_version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the eXosip version as a sring
</div>
</div><p>
<a class="anchor" name="gbf881c83da7f6c25e791938c18824a4e"></a><!-- doxytag: member="eX_setup.h::eXosip_enable_ipv6" ref="gbf881c83da7f6c25e791938c18824a4e" args="(int ipv6_enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void eXosip_enable_ipv6 </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ipv6_enable</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Use IPv6 instead of IPv4.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ipv6_enable</em> </td><td>This paramter should be set to 1 to enable IPv6 mode. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gbd30814449260a3a69e11eaec444f245"></a><!-- doxytag: member="eX_setup.h::eXosip_masquerade_contact" ref="gbd30814449260a3a69e11eaec444f245" args="(const char *public_address, int port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void eXosip_masquerade_contact </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>public_address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>public_address</em> </td><td>the ip address. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>the port for masquerading.</td></tr>
</table>
</dl>
If set to NULL, then the local ip address will be guessed automatically (returns to default mode).
</div>
</div><p>
<a class="anchor" name="g977e8a8567177fce827da56c27a1e2ab"></a><!-- doxytag: member="eX_setup.h::eXosip_find_free_port" ref="g977e8a8567177fce827da56c27a1e2ab" args="(int free_port, int transport)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_find_free_port </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>free_port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>transport</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method is used to find out an free IPPROTO_UDP or IPPROTO_TCP port.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>free_port</em> </td><td>initial port for search. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>transport</em> </td><td>IPPROTO_UDP or IPPROTO_TCP protocol. </td></tr>
</table>
</dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 15:51:58 2009 for libeXosip2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
