📄 group__osip__www__authenticate.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>libosip: oSIP www-authenticate header definition.</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div><h1>oSIP www-authenticate header definition.<br><small>[<a class="el" href="group__oSIP__HEADERS.html">oSIP headers definitions</a>]</small></h1><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Classes</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structosip__www__authenticate.html">osip_www_authenticate</a></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structosip__www__authenticate.html">osip_www_authenticate</a></td></tr><tr><td colspan=2><br><h2>Defines</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga22">osip_www_authenticate_set_stale_true</a>(header) osip_www_authenticate_set_stale(header,osip_strdup("true"))</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga23">osip_www_authenticate_set_stale_false</a>(header) osip_www_authenticate_set_stale(header,osip_strdup("false"))</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga24">osip_www_authenticate_set_algorithm_MD5</a>(header) osip_www_authenticate_set_algorithm(header,osip_strdup("MD5"))</td></tr><tr><td colspan=2><br><h2>Typedefs</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="structosip__www__authenticate.html">osip_www_authenticate</a> </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga0">osip_www_authenticate_t</a></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__oSIP__WWW__AUTHENTICATE.html#ga1">osip_www_authenticate_init</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> **header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga2">osip_www_authenticate_parse</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, const char *hvalue)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga3">osip_www_authenticate_to_str</a> (const <a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char **dest)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga4">osip_www_authenticate_free</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga5">osip_www_authenticate_clone</a> (const <a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, <a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> **dest)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga6">osip_www_authenticate_get_auth_type</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga7">osip_www_authenticate_set_auth_type</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga8">osip_www_authenticate_get_realm</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga9">osip_www_authenticate_set_realm</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga10">osip_www_authenticate_get_domain</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga11">osip_www_authenticate_set_domain</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga12">osip_www_authenticate_get_nonce</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga13">osip_www_authenticate_set_nonce</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga14">osip_www_authenticate_get_opaque</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga15">osip_www_authenticate_set_opaque</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga16">osip_www_authenticate_get_stale</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga17">osip_www_authenticate_set_stale</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga18">osip_www_authenticate_get_algorithm</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga19">osip_www_authenticate_set_algorithm</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga20">osip_www_authenticate_get_qop_options</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__WWW__AUTHENTICATE.html#ga21">osip_www_authenticate_set_qop_options</a> (<a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> *header, char *value)</td></tr></table><hr><h2>Define Documentation</h2><a class="anchor" name="ga24" doxytag="osip_www_authenticate.h::osip_www_authenticate_set_algorithm_MD5" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define osip_www_authenticate_set_algorithm_MD5 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">header </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> osip_www_authenticate_set_algorithm(header,osip_strdup("MD5"))</td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Add the algorithm parameter set to "MD5" in a Www-Authenticate element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>header</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga23" doxytag="osip_www_authenticate.h::osip_www_authenticate_set_stale_false" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define osip_www_authenticate_set_stale_false </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">header </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> osip_www_authenticate_set_stale(header,osip_strdup("false"))</td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Add a stale parameter set to "false" in a Www-Authenticate element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>header</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga22" doxytag="osip_www_authenticate.h::osip_www_authenticate_set_stale_true" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define osip_www_authenticate_set_stale_true </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">header </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> osip_www_authenticate_set_stale(header,osip_strdup("true"))</td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Add a stale parameter set to "true" in a Www-Authenticate element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>header</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><hr><h2>Typedef Documentation</h2><a class="anchor" name="ga0" doxytag="osip_www_authenticate.h::osip_www_authenticate_t" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Structure for WWW-Authenticate headers. </td> </tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="ga5" doxytag="osip_www_authenticate.h::osip_www_authenticate_clone" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int osip_www_authenticate_clone </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> * </td> <td class="mdname" nowrap> <em>header</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap><a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> ** </td> <td class="mdname" nowrap> <em>dest</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Clone a Www-Authenticate element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>header</em> </td><td>The element to work on. </td></tr> <tr><td></td><td valign=top><em>dest</em> </td><td>A pointer on the copy of the element. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga4" doxytag="osip_www_authenticate.h::osip_www_authenticate_free" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void osip_www_authenticate_free </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>header</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Free a Www-Authenticate element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>header</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga18" doxytag="osip_www_authenticate.h::osip_www_authenticate_get_algorithm" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> char* osip_www_authenticate_get_algorithm </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>header</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get value of the algorithm parameter from a Www-Authenticate element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>header</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga6" doxytag="osip_www_authenticate.h::osip_www_authenticate_get_auth_type" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> char* osip_www_authenticate_get_auth_type </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__www__authenticate.html">osip_www_authenticate_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>header</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get value of the auth_type parameter from a Www-Authenticate element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>header</em> </td><td>The element to work on. </td></tr> </table></dl>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -