<!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 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.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 authentication API<br>
<small>
[<a class="el" href="group__eXosip2__msg.html">SIP messages and call control 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__authentication.html#g7a2bcd36a22919743da23f61cc6663a0">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" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#g36f0d2b77e4485b8b7bed96c082592b5">eXosip_clear_authentication_info</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__authentication.html#g55b275932340fc2a1abd5242aca54767">eXosip_default_action</a> (<a class="el" href="structeXosip__event.html">eXosip_event_t</a> *je)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#g1360c11a65da010a46514f43e21eb718">eXosip_automatic_refresh</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__authentication.html#gc4fb70cd9af20fbc16c72c660cb7c372">eXosip_automatic_action</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__authentication.html#g4495417ae52e7bbc40e0f34c55d53ce5">eXosip_insubscription_automatic</a> (<a class="el" href="structeXosip__event.html">eXosip_event_t</a> *evt)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eXosip2__authentication.html#gb3cf3bd8e342e63e644a772b358b15e6">eXosip_generate_random</a> (char *buf, int buf_size)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g7a2bcd36a22919743da23f61cc6663a0"></a><!-- doxytag: member="eXosip.h::eXosip_add_authentication_info" ref="g7a2bcd36a22919743da23f61cc6663a0" 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><td> </td>
</tr>
<tr>
<td></td>
<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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>username</em> </td><td>username </td></tr>
<tr><td valign="top"></td><td valign="top"><em>userid</em> </td><td>login (usually equals the username) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>passwd</em> </td><td>password </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ha1</em> </td><td>currently ignored </td></tr>
<tr><td valign="top"></td><td valign="top"><em>realm</em> </td><td>realm within which credentials apply, or NULL to apply credentials to unrecognized realms </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g36f0d2b77e4485b8b7bed96c082592b5"></a><!-- doxytag: member="eXosip.h::eXosip_clear_authentication_info" ref="g36f0d2b77e4485b8b7bed96c082592b5" 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.
</div>
</div><p>
<a class="anchor" name="g55b275932340fc2a1abd5242aca54767"></a><!-- doxytag: member="eXosip.h::eXosip_default_action" ref="g55b275932340fc2a1abd5242aca54767" 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>
Retry with credentials upon reception of 401/407. Retry with Contact header upon reception of 3xx request.
</div>
</div><p>
<a class="anchor" name="g1360c11a65da010a46514f43e21eb718"></a><!-- doxytag: member="eXosip.h::eXosip_automatic_refresh" ref="g1360c11a65da010a46514f43e21eb718" 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.
</div>
</div><p>
<a class="anchor" name="gc4fb70cd9af20fbc16c72c660cb7c372"></a><!-- doxytag: member="eXosip.h::eXosip_automatic_action" ref="gc4fb70cd9af20fbc16c72c660cb7c372" 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>
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.
</div>
</div><p>
<a class="anchor" name="g4495417ae52e7bbc40e0f34c55d53ce5"></a><!-- doxytag: member="eXosip.h::eXosip_insubscription_automatic" ref="g4495417ae52e7bbc40e0f34c55d53ce5" 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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>evt</em> </td><td>event related to an incoming subscription. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gb3cf3bd8e342e63e644a772b358b15e6"></a><!-- doxytag: member="eXosip.h::eXosip_generate_random" ref="gb3cf3bd8e342e63e644a772b358b15e6" 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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Generate random 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>buf</em> </td><td>destination buffer for random string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf_size</em> </td><td>size of destination buffer </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>
