<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libeXosip2: eXosip2 authentication 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.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libeXosip2 <span id="projectnumber">3.1.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">eXosip2 authentication API</div> </div>
<div class="ingroups"><a class="el" href="group__eXosip2__msg.html">SIP messages and call control API</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#ga7a2bcd36a22919743da23f61cc6663a0">eXosip_add_authentication_info</a> (const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#ga36f0d2b77e4485b8b7bed96c082592b5">eXosip_clear_authentication_info</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#ga55b275932340fc2a1abd5242aca54767">eXosip_default_action</a> (<a class="el" href="structeXosip__event.html">eXosip_event_t</a> *je)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#ga1360c11a65da010a46514f43e21eb718">eXosip_automatic_refresh</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#gac4fb70cd9af20fbc16c72c660cb7c372">eXosip_automatic_action</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#ga4495417ae52e7bbc40e0f34c55d53ce5">eXosip_insubscription_automatic</a> (<a class="el" href="structeXosip__event.html">eXosip_event_t</a> *evt)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#gab3cf3bd8e342e63e644a772b358b15e6">eXosip_generate_random</a> (char *buf, int buf_size)</td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7a2bcd36a22919743da23f61cc6663a0"></a><!-- doxytag: member="eXosip.h::eXosip_add_authentication_info" ref="ga7a2bcd36a22919743da23f61cc6663a0" args="(const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_add_authentication_info </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>userid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>passwd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ha1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>realm</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add authentication credentials. These are used when an outgoing request comes back with an authorization required response.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">username</td><td>username </td></tr>
<tr><td class="paramname">userid</td><td>login (usually equals the username) </td></tr>
<tr><td class="paramname">passwd</td><td>password </td></tr>
<tr><td class="paramname">ha1</td><td>currently ignored </td></tr>
<tr><td class="paramname">realm</td><td>realm within which credentials apply, or NULL to apply credentials to unrecognized realms </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga36f0d2b77e4485b8b7bed96c082592b5"></a><!-- doxytag: member="eXosip.h::eXosip_clear_authentication_info" ref="ga36f0d2b77e4485b8b7bed96c082592b5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_clear_authentication_info </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear all authentication credentials stored in eXosip. </p>
</div>
</div>
<a class="anchor" id="ga55b275932340fc2a1abd5242aca54767"></a><!-- doxytag: member="eXosip.h::eXosip_default_action" ref="ga55b275932340fc2a1abd5242aca54767" args="(eXosip_event_t *je)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_default_action </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structeXosip__event.html">eXosip_event_t</a> * </td>
<td class="paramname"><em>je</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initiate some default actions:</p>
<p>Retry with credentials upon reception of 401/407. Retry with Contact header upon reception of 3xx request. </p>
</div>
</div>
<a class="anchor" id="ga1360c11a65da010a46514f43e21eb718"></a><!-- doxytag: member="eXosip.h::eXosip_automatic_refresh" ref="ga1360c11a65da010a46514f43e21eb718" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void eXosip_automatic_refresh </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Refresh REGISTER and SUBSCRIBE before the expiration delay. </p>
</div>
</div>
<a class="anchor" id="gac4fb70cd9af20fbc16c72c660cb7c372"></a><!-- doxytag: member="eXosip.h::eXosip_automatic_action" ref="gac4fb70cd9af20fbc16c72c660cb7c372" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void eXosip_automatic_action </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initiate some automatic actions:</p>
<p>Retry with credentials upon reception of 401/407. Refresh REGISTER and SUBSCRIBE before the expiration delay. Retry with Contact header upon reception of 3xx request. </p>
</div>
</div>
<a class="anchor" id="ga4495417ae52e7bbc40e0f34c55d53ce5"></a><!-- doxytag: member="eXosip.h::eXosip_insubscription_automatic" ref="ga4495417ae52e7bbc40e0f34c55d53ce5" args="(eXosip_event_t *evt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_insubscription_automatic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structeXosip__event.html">eXosip_event_t</a> * </td>
<td class="paramname"><em>evt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Automatic internal handling of known package.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">evt</td><td>event related to an incoming subscription. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab3cf3bd8e342e63e644a772b358b15e6"></a><!-- doxytag: member="eXosip.h::eXosip_generate_random" ref="gab3cf3bd8e342e63e644a772b358b15e6" args="(char *buf, int buf_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eXosip_generate_random </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buf_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generate random string:</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>destination buffer for random string. </td></tr>
<tr><td class="paramname">buf_size</td><td>size of destination buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Sep 2 2011 for libeXosip2 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
