<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Yate: JIDFeatureSasl Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1JIDFeatureSasl.html">JIDFeatureSasl</a> </div> </div> <div class="contents"> <h1>JIDFeatureSasl Class Reference</h1><!-- doxytag: class="TelEngine::JIDFeatureSasl" --><!-- doxytag: inherits="TelEngine::JIDFeature" -->A JID's SASL feature. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="xmpputils_8h-source.html">xmpputils.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for JIDFeatureSasl:</div> <div class="dynsection"> <p><center><img src="classTelEngine_1_1JIDFeatureSasl.png" usemap="#JIDFeatureSasl_map" border="0" alt=""></center> <map name="JIDFeatureSasl_map"> <area href="classTelEngine_1_1JIDFeature.html" alt="JIDFeature" shape="rect" coords="0,112,99,136"> <area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,99,80"> <area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,99,24"> </map> </div> <p> <a href="classTelEngine_1_1JIDFeatureSasl-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#003177e1998c999a0ee3b28fb7c5db4c">Mechanism</a> { <b>MechNone</b> = 0x00, <b>MechMD5</b> = 0x01, <b>MechSHA1</b> = 0x02, <b>MechPlain</b> = 0x04 }</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#249248fde1c4f75b75628a0d8975e60f">JIDFeatureSasl</a> (int mech, bool required=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#1fca06269513976f7973eb5c9dbec250">mechanism</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#d5f1e14bd266043bd5ad36cc7918280c">mechanism</a> (<a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#003177e1998c999a0ee3b28fb7c5db4c">Mechanism</a> mech) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#971668e81e6e5e412fec8c20563240c2">operator XMPPNamespace::Type</a> ()</td></tr> <tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#f129033ce982fc6efffe5d9e709178fe">s_authMech</a> []</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A JID's SASL feature. <p> This class holds a JID SASL feature (authentication methods) <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="003177e1998c999a0ee3b28fb7c5db4c"></a><!-- doxytag: member="TelEngine::JIDFeatureSasl::Mechanism" ref="003177e1998c999a0ee3b28fb7c5db4c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#003177e1998c999a0ee3b28fb7c5db4c">Mechanism</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Mechanisms used to authenticate a stream </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="249248fde1c4f75b75628a0d8975e60f"></a><!-- doxytag: member="TelEngine::JIDFeatureSasl::JIDFeatureSasl" ref="249248fde1c4f75b75628a0d8975e60f" args="(int mech, bool required=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html">JIDFeatureSasl</a> </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>mech</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>required</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mech</em> </td><td>Authentication mechanisms used by the JID </td></tr> <tr><td valign="top"></td><td valign="top"><em>required</em> </td><td>Required flag </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="d5f1e14bd266043bd5ad36cc7918280c"></a><!-- doxytag: member="TelEngine::JIDFeatureSasl::mechanism" ref="d5f1e14bd266043bd5ad36cc7918280c" args="(Mechanism mech) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mechanism </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#003177e1998c999a0ee3b28fb7c5db4c">Mechanism</a> </td> <td class="paramname"> <em>mech</em> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Check if a given mechanism is allowed <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the given mechanism is allowed </dd></dl> </div> </div><p> <a class="anchor" name="1fca06269513976f7973eb5c9dbec250"></a><!-- doxytag: member="TelEngine::JIDFeatureSasl::mechanism" ref="1fca06269513976f7973eb5c9dbec250" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mechanism </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the authentication mechanisms used by the JID <dl class="return" compact><dt><b>Returns:</b></dt><dd>The authentication mechanisms used by the JID </dd></dl> </div> </div><p> <a class="anchor" name="971668e81e6e5e412fec8c20563240c2"></a><!-- doxytag: member="TelEngine::JIDFeatureSasl::operator XMPPNamespace::Type" ref="971668e81e6e5e412fec8c20563240c2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">operator XMPPNamespace::Type </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> XMPPNamespace::Type conversion operator <p>Reimplemented from <a class="el" href="classTelEngine_1_1JIDFeature.html#971668e81e6e5e412fec8c20563240c2">JIDFeature</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="f129033ce982fc6efffe5d9e709178fe"></a><!-- doxytag: member="TelEngine::JIDFeatureSasl::s_authMech" ref="f129033ce982fc6efffe5d9e709178fe" args="[]" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> <a class="el" href="classTelEngine_1_1JIDFeatureSasl.html#f129033ce982fc6efffe5d9e709178fe">s_authMech</a>[]<code> [static]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Authentication mechanism names </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="xmpputils_8h-source.html">xmpputils.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address> </body> </html>