<!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: ClientAccount 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_1ClientAccount.html">ClientAccount</a>
</div>
</div>
<div class="contents">
<h1>ClientAccount Class Reference</h1><!-- doxytag: class="TelEngine::ClientAccount" --><!-- doxytag: inherits="TelEngine::RefObject,TelEngine::Mutex" -->A client account.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatecbase_8h-source.html">yatecbase.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for ClientAccount:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ClientAccount.png" usemap="#ClientAccount_map" border="0" alt=""></center>
<map name="ClientAccount_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,91,80">
<area href="classTelEngine_1_1Mutex.html" alt="Mutex" shape="rect" coords="101,56,192,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,91,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1ClientAccount-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 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_1ClientAccount.html#84d9ee3772b6a2e2aa1377740f6842ef">ClientAccount</a> (const char *proto, const char *user, const char *host, bool startup)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#0577a26d3d4396b4d081aa22b0ac177b">ClientAccount</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1URI.html">URI</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#ae1f9ac7c016cf12c35e0e8f1cd034f3">uri</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1URI.html">URI</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#c046fa9c5d85562b0697bf7bb36b45df">id</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#8847ee7b9377aebebbfa871f0d4a6ed8">contacts</a> ()</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_1ClientAccount.html#4a7bd56fb99593ace9379ed699f2719c">toString</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#de077b891b4b52c41ca0eea130f9f157">resource</a> (bool ref=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#f702e6bcf4af8253c16b54f0fee2d816">setResource</a> (<a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a> *res=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#44e2ab3794c2dd2e689fef6c49d7721e">findContact</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id, bool ref=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#ad3a77a0156fb9bcf2cdbf2a90b509c5">findContact</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id, const <a class="el" href="classTelEngine_1_1String.html">String</a> &resid, bool ref=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#04ea8f4cb97f9dc464b0dee2ef243488">appendContact</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id, const char *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#1ea47ea3bdb69879c1142ef0b5fccc0e">appendContact</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#e1bc26f2a5fe5f44c5937cb16fa1a63d">removeContact</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id, bool delObj=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1Message.html">Message</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#ad39468f9b3e20abd456b787cf619da0">userlogin</a> (bool login, const char *msg="user.login")</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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientAccount.html#b89b6abe4932e83faf175d7945dc0581">buildAccountId</a> (<a class="el" href="classTelEngine_1_1URI.html">URI</a> &dest, const char *proto, const char *user, const char *host)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e83497974c7f7c20068de5b0afc9a343"></a><!-- doxytag: member="TelEngine::ClientAccount::m_password" ref="e83497974c7f7c20068de5b0afc9a343" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_password</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21e7b692b4b2e41026a3f9bb3bbe9a97"></a><!-- doxytag: member="TelEngine::ClientAccount::m_server" ref="21e7b692b4b2e41026a3f9bb3bbe9a97" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_server</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="664f68281fb64c5687e8f160fd6e4372"></a><!-- doxytag: member="TelEngine::ClientAccount::m_port" ref="664f68281fb64c5687e8f160fd6e4372" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_port</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="916f0c972db35e169fd14ea3ac32c73f"></a><!-- doxytag: member="TelEngine::ClientAccount::m_options" ref="916f0c972db35e169fd14ea3ac32c73f" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_options</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d5b2c7debfb0ce70bb4e701020acd9d"></a><!-- doxytag: member="TelEngine::ClientAccount::m_startup" ref="2d5b2c7debfb0ce70bb4e701020acd9d" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_startup</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="288b7dcd81707d69b02d6f844961cc9b"></a><!-- doxytag: member="TelEngine::ClientAccount::m_outbound" ref="288b7dcd81707d69b02d6f844961cc9b" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_outbound</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f7b94d7356adbf6ae76c9f0b5a7eb12e"></a><!-- doxytag: member="TelEngine::ClientAccount::m_expires" ref="f7b94d7356adbf6ae76c9f0b5a7eb12e" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_expires</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb58ea70e4937457a6a0c252cd5c4bb"></a><!-- doxytag: member="TelEngine::ClientAccount::m_connected" ref="7fb58ea70e4937457a6a0c252cd5c4bb" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_connected</b></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></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_1ClientAccount.html#29e169c1327513d2db6127ddb301dc19">destroyed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a767ecd4bba10a5c58f17251ecb54f11"></a><!-- doxytag: member="TelEngine::ClientAccount::appendContact" ref="a767ecd4bba10a5c58f17251ecb54f11" args="(ClientContact *contact)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>appendContact</b> (<a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> *contact)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6dd1abba9bfa71f2182e20ab69a5a703"></a><!-- doxytag: member="TelEngine::ClientAccount::setIdUri" ref="6dd1abba9bfa71f2182e20ab69a5a703" args="(const char *proto, const char *user, const char *host)" -->
void </td><td class="memItemRight" valign="bottom"><b>setIdUri</b> (const char *proto, const char *user, const char *host)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a19466faf0e45c026a7006334884c1a"></a><!-- doxytag: member="TelEngine::ClientAccount::m_id" ref="2a19466faf0e45c026a7006334884c1a" args="" -->
<a class="el" href="classTelEngine_1_1URI.html">URI</a> </td><td class="memItemRight" valign="bottom"><b>m_id</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69c81746c9fc4a8b8957d9df67a2dae3"></a><!-- doxytag: member="TelEngine::ClientAccount::m_uri" ref="69c81746c9fc4a8b8957d9df67a2dae3" args="" -->
<a class="el" href="classTelEngine_1_1URI.html">URI</a> </td><td class="memItemRight" valign="bottom"><b>m_uri</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6297ae2df493a3d509816fe2216e1fa"></a><!-- doxytag: member="TelEngine::ClientAccount::m_resource" ref="a6297ae2df493a3d509816fe2216e1fa" args="" -->
<a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a> * </td><td class="memItemRight" valign="bottom"><b>m_resource</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29033b6ce88516352db15fa4b6d95a4b"></a><!-- doxytag: member="TelEngine::ClientAccount::m_contacts" ref="29033b6ce88516352db15fa4b6d95a4b" args="" -->
<a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> </td><td class="memItemRight" valign="bottom"><b>m_contacts</b></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="704f4196dfb7a98a91a12e214e1ba136"></a><!-- doxytag: member="TelEngine::ClientAccount::ClientContact" ref="704f4196dfb7a98a91a12e214e1ba136" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ClientContact</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A client account.
<p>
This class holds data about an account that can be registered to a server. It also holds a list of contacts belonging to this account. The account's id is kept in a lower case <a class="el" href="classTelEngine_1_1URI.html" title="Encapsulation for an URI.">URI</a> <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="84d9ee3772b6a2e2aa1377740f6842ef"></a><!-- doxytag: member="TelEngine::ClientAccount::ClientAccount" ref="84d9ee3772b6a2e2aa1377740f6842ef" args="(const char *proto, const char *user, const char *host, bool startup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>proto</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>startup</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></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>proto</em> </td><td>The account's protocol </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>The account's username </td></tr>
<tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>The account's host </td></tr>
<tr><td valign="top"></td><td valign="top"><em>startup</em> </td><td>True if the account should login at startup </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0577a26d3d4396b4d081aa22b0ac177b"></a><!-- doxytag: member="TelEngine::ClientAccount::ClientAccount" ref="0577a26d3d4396b4d081aa22b0ac177b" args="(const NamedList &params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td>
<td class="paramname"> <em>params</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Build an account from a list of parameters <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>The list of parameters used to build this account </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1ea47ea3bdb69879c1142ef0b5fccc0e"></a><!-- doxytag: member="TelEngine::ClientAccount::appendContact" ref="1ea47ea3bdb69879c1142ef0b5fccc0e" args="(const NamedList &params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a>* appendContact </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td>
<td class="paramname"> <em>params</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build a contact and append it to the list <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>Contact parameters </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientContact.html" title="A client contact.">ClientContact</a> pointer or 0 if a contact with the same id already exists </dd></dl>
</div>
</div><p>
<a class="anchor" name="04ea8f4cb97f9dc464b0dee2ef243488"></a><!-- doxytag: member="TelEngine::ClientAccount::appendContact" ref="04ea8f4cb97f9dc464b0dee2ef243488" args="(const String &id, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a>* appendContact </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build a contact and append it to the list <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The contact's id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The contact's name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientContact.html" title="A client contact.">ClientContact</a> pointer or 0 if a contact with the given id already exists </dd></dl>
</div>
</div><p>
<a class="anchor" name="b89b6abe4932e83faf175d7945dc0581"></a><!-- doxytag: member="TelEngine::ClientAccount::buildAccountId" ref="b89b6abe4932e83faf175d7945dc0581" args="(URI &dest, const char *proto, const char *user, const char *host)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void buildAccountId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1URI.html">URI</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>proto</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>host</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build an account id <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination <a class="el" href="classTelEngine_1_1URI.html" title="Encapsulation for an URI.">URI</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>proto</em> </td><td>The account's protocol </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>The account's username </td></tr>
<tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>The account's host </td></tr>
</table>
</dl>
<p>References <a class="el" href="classTelEngine_1_1String.html#8fd5f3c864af3d60885cc09888dd18d3">String::toLower()</a>.</p>
</div>
</div><p>
<a class="anchor" name="8847ee7b9377aebebbfa871f0d4a6ed8"></a><!-- doxytag: member="TelEngine::ClientAccount::contacts" ref="8847ee7b9377aebebbfa871f0d4a6ed8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a>& contacts </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get this account's contacts. The caller should lock the account while browsing the list <dl class="return" compact><dt><b>Returns:</b></dt><dd>This account's contacts list </dd></dl>
</div>
</div><p>
<a class="anchor" name="29e169c1327513d2db6127ddb301dc19"></a><!-- doxytag: member="TelEngine::ClientAccount::destroyed" ref="29e169c1327513d2db6127ddb301dc19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void destroyed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pre-destruction notification, called just before the object is deleted. Unlike in the destructor it is safe to call virtual methods here. Reimplementing this method allows to perform any object cleanups.
<p>Reimplemented from <a class="el" href="classTelEngine_1_1RefObject.html#29e169c1327513d2db6127ddb301dc19">RefObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="ad3a77a0156fb9bcf2cdbf2a90b509c5"></a><!-- doxytag: member="TelEngine::ClientAccount::findContact" ref="ad3a77a0156fb9bcf2cdbf2a90b509c5" args="(const String &id, const String &resid, bool ref=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a>* findContact </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>resid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ref</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a contact having a given id and resource <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the desired contact </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resid</em> </td><td>The id of the desired resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ref</em> </td><td>True to obtain a referenced pointer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientContact.html" title="A client contact.">ClientContact</a> pointer or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="44e2ab3794c2dd2e689fef6c49d7721e"></a><!-- doxytag: member="TelEngine::ClientAccount::findContact" ref="44e2ab3794c2dd2e689fef6c49d7721e" args="(const String &id, bool ref=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a>* findContact </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ref</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a contact by its id <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the desired contact </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ref</em> </td><td>True to obtain a referenced pointer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientContact.html" title="A client contact.">ClientContact</a> pointer or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="c046fa9c5d85562b0697bf7bb36b45df"></a><!-- doxytag: member="TelEngine::ClientAccount::id" ref="c046fa9c5d85562b0697bf7bb36b45df" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1URI.html">URI</a>& id </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get this account's id <dl class="return" compact><dt><b>Returns:</b></dt><dd>This account's id </dd></dl>
</div>
</div><p>
<a class="anchor" name="e1bc26f2a5fe5f44c5937cb16fa1a63d"></a><!-- doxytag: member="TelEngine::ClientAccount::removeContact" ref="e1bc26f2a5fe5f44c5937cb16fa1a63d" args="(const String &id, bool delObj=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a>* removeContact </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>delObj</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a contact from list. Reset contact's owner <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The contact's id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>delObj</em> </td><td>True to delete the object if found </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientContact.html" title="A client contact.">ClientContact</a> pointer if found and not deleted or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="de077b891b4b52c41ca0eea130f9f157"></a><!-- doxytag: member="TelEngine::ClientAccount::resource" ref="de077b891b4b52c41ca0eea130f9f157" args="(bool ref=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a>* resource </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ref</em> = <code>false</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get this account's resource <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientResource.html" title="A client contact's resource.">ClientResource</a> pointer or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f702e6bcf4af8253c16b54f0fee2d816"></a><!-- doxytag: member="TelEngine::ClientAccount::setResource" ref="f702e6bcf4af8253c16b54f0fee2d816" args="(ClientResource *res=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setResource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a> * </td>
<td class="paramname"> <em>res</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/reset this account's resource <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>res</em> </td><td>The new account's resource </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4a7bd56fb99593ace9379ed699f2719c"></a><!-- doxytag: member="TelEngine::ClientAccount::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>The account's compare id </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#4a7bd56fb99593ace9379ed699f2719c">GenObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="ae1f9ac7c016cf12c35e0e8f1cd034f3"></a><!-- doxytag: member="TelEngine::ClientAccount::uri" ref="ae1f9ac7c016cf12c35e0e8f1cd034f3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1URI.html">URI</a>& uri </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get this account's <a class="el" href="classTelEngine_1_1URI.html" title="Encapsulation for an URI.">URI</a> <dl class="return" compact><dt><b>Returns:</b></dt><dd>This account's <a class="el" href="classTelEngine_1_1URI.html" title="Encapsulation for an URI.">URI</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ad39468f9b3e20abd456b787cf619da0"></a><!-- doxytag: member="TelEngine::ClientAccount::userlogin" ref="ad39468f9b3e20abd456b787cf619da0" args="(bool login, const char *msg="user.login")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1Message.html">Message</a>* userlogin </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>login</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>msg</em> = <code>"user.login"</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build a login/logout message from account's data <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>login</em> </td><td>True to login, false to logout </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Optional message name. Default to 'user.login' </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A valid <a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> pointer </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatecbase_8h-source.html">yatecbase.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 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
>
55
