<!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: JIDIdentity 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_1JIDIdentity.html">JIDIdentity</a>
</div>
</div>
<div class="contents">
<h1>JIDIdentity Class Reference</h1><!-- doxytag: class="TelEngine::JIDIdentity" --><!-- doxytag: inherits="TelEngine::RefObject" -->A JID identity.
<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 JIDIdentity:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1JIDIdentity.png" usemap="#JIDIdentity_map" border="0" alt=""></center>
<map name="JIDIdentity_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,72,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,72,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1JIDIdentity-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_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> { <br>
<b>Account</b>,
<b>Client</b>,
<b>Component</b>,
<b>Gateway</b>,
<br>
<b>CategoryUnknown</b>
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <br>
<b>AccountRegistered</b>,
<b>ClientPhone</b>,
<b>ComponentGeneric</b>,
<b>ComponentPresence</b>,
<br>
<b>GatewayGeneric</b>,
<b>TypeUnknown</b>
<br>
}</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_1JIDIdentity.html#e906959d28572f0fa51b8861fb52cf8e">JIDIdentity</a> (<a class="el" href="classTelEngine_1_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> c, <a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> t, const char *name=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#ca6188f071266d62fb71a9d623e63698">~JIDIdentity</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#0d90793cb15e05c2e9e10fc84b2953c5">toXML</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#73c4dff87b3d5c7897ccff02700b1d01">fromXML</a> (const <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *element)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#4a7bd56fb99593ace9379ed699f2719c">toString</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#b3a256e7d9fad73fa57de7c1fedf51c5">setName</a> (const char *name)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#1563b28a2c7dc4b3bae17a9b546f4ed6">categoryText</a> (<a class="el" href="classTelEngine_1_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> c)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#677c7464f82fb8fc6ee71727b076a508">categoryValue</a> (const char *c)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#b454ccbfa16112765a255bb1ddcb4445">typeText</a> (<a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> t)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JIDIdentity.html#282d97442ade12bd7205684843b8bada">typeValue</a> (const char *t)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A JID identity.
<p>
This class holds an identity for a JID <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="9ca8f05608edcbf85ab6c2c85a439ccb"></a><!-- doxytag: member="TelEngine::JIDIdentity::Category" ref="9ca8f05608edcbf85ab6c2c85a439ccb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
JID category enumeration
</div>
</div><p>
<a class="anchor" name="1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="TelEngine::JIDIdentity::Type" ref="1d1cfd8ffb84e947f82999c682b666a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
JID type enumeration
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e906959d28572f0fa51b8861fb52cf8e"></a><!-- doxytag: member="TelEngine::JIDIdentity::JIDIdentity" ref="e906959d28572f0fa51b8861fb52cf8e" args="(Category c, Type t, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JIDIdentity.html">JIDIdentity</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> </td>
<td class="paramname"> <em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>0</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. Build a JID identity <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>The JID's category </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>The JID's type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of this identity </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ca6188f071266d62fb71a9d623e63698"></a><!-- doxytag: member="TelEngine::JIDIdentity::~JIDIdentity" ref="ca6188f071266d62fb71a9d623e63698" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1JIDIdentity.html">JIDIdentity</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1563b28a2c7dc4b3bae17a9b546f4ed6"></a><!-- doxytag: member="TelEngine::JIDIdentity::categoryText" ref="1563b28a2c7dc4b3bae17a9b546f4ed6" args="(Category c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* categoryText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lookup for a text associated with a given category <dl class="return" compact><dt><b>Returns:</b></dt><dd>The category's name </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="677c7464f82fb8fc6ee71727b076a508"></a><!-- doxytag: member="TelEngine::JIDIdentity::categoryValue" ref="677c7464f82fb8fc6ee71727b076a508" args="(const char *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1JIDIdentity.html#9ca8f05608edcbf85ab6c2c85a439ccb">Category</a> categoryValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lookup for a value associated with a given category name <dl class="return" compact><dt><b>Returns:</b></dt><dd>The category's value </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="73c4dff87b3d5c7897ccff02700b1d01"></a><!-- doxytag: member="TelEngine::JIDIdentity::fromXML" ref="73c4dff87b3d5c7897ccff02700b1d01" args="(const XMLElement *element)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool fromXML </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td>
<td class="paramname"> <em>element</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build this identity from an XML element <dl class="return" compact><dt><b>Returns:</b></dt><dd>True on succes </dd></dl>
</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::JIDIdentity::getObject" ref="aa71c3294b1a073c3ad0b64a2ed6325a" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* getObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer from this object <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The requested pointer's name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Requested pointer or 0 </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#aa71c3294b1a073c3ad0b64a2ed6325a">GenObject</a>.</p>
<p>References <a class="el" href="classTelEngine_1_1GenObject.html#aa71c3294b1a073c3ad0b64a2ed6325a">GenObject::getObject()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3a256e7d9fad73fa57de7c1fedf51c5"></a><!-- doxytag: member="TelEngine::JIDIdentity::setName" ref="b3a256e7d9fad73fa57de7c1fedf51c5" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the name of this identity <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>New identity name </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4a7bd56fb99593ace9379ed699f2719c"></a><!-- doxytag: member="TelEngine::JIDIdentity::toString" ref="4a7bd56fb99593ace9379ed699f2719c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a>& toString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a string representation of this object <dl class="return" compact><dt><b>Returns:</b></dt><dd>This object's name </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#4a7bd56fb99593ace9379ed699f2719c">GenObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="0d90793cb15e05c2e9e10fc84b2953c5"></a><!-- doxytag: member="TelEngine::JIDIdentity::toXML" ref="0d90793cb15e05c2e9e10fc84b2953c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* toXML </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build an XML element from this identity <dl class="return" compact><dt><b>Returns:</b></dt><dd>A valid XML element </dd></dl>
</div>
</div><p>
<a class="anchor" name="b454ccbfa16112765a255bb1ddcb4445"></a><!-- doxytag: member="TelEngine::JIDIdentity::typeText" ref="b454ccbfa16112765a255bb1ddcb4445" args="(Type t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* typeText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lookup for a text associated with a given category type <dl class="return" compact><dt><b>Returns:</b></dt><dd>The category's type name </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="282d97442ade12bd7205684843b8bada"></a><!-- doxytag: member="TelEngine::JIDIdentity::typeValue" ref="282d97442ade12bd7205684843b8bada" args="(const char *t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1JIDIdentity.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> typeValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lookup for a value associated with a given category type <dl class="return" compact><dt><b>Returns:</b></dt><dd>The category's type value </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
278
