Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 230

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!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: JBMessage 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1JBMessage.html">JBMessage</a>
  </div>
</div>
<div class="contents">
<h1>JBMessage Class Reference</h1><!-- doxytag: class="TelEngine::JBMessage" --><!-- doxytag: inherits="TelEngine::JBService,TelEngine::JBThreadList" -->A Jabber message service.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="yatejabber_8h-source.html">yatejabber.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for JBMessage:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1JBMessage.png" usemap="#JBMessage_map" border="0" alt=""></center>
<map name="JBMessage_map">
<area href="classTelEngine_1_1JBService.html" alt="JBService" shape="rect" coords="103,56,196,80">
<area href="classTelEngine_1_1JBThreadList.html" alt="JBThreadList" shape="rect" coords="206,56,299,80">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="0,0,93,24">
<area href="classTelEngine_1_1Mutex.html" alt="Mutex" shape="rect" coords="103,0,196,24">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="206,0,299,24">
</map>
</div>

<p>
<a href="classTelEngine_1_1JBMessage-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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a> { <br>
&nbsp;&nbsp;<b>Chat</b>, 
<b>GroupChat</b>, 
<b>HeadLine</b>, 
<b>Normal</b>, 
<br>
&nbsp;&nbsp;<b>Error</b>, 
<b>None</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#c3c10ed9002c8c7bd02f3c9aed3cc019">JBMessage</a> (<a class="el" href="classTelEngine_1_1JBEngine.html">JBEngine</a> *engine, const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> *params, int prio=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#d8bec1f689f893e40a11f7212c374143">~JBMessage</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#c391e1e7a016b4064486b5994fc1fed7">initialize</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;params)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JBEvent.html">JBEvent</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#c9e7d1066fd09869137479a8442d28b3">getMessage</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#fcc65e410c45d66377d6a6d18679ec92">processMessage</a> (<a class="el" href="classTelEngine_1_1JBEvent.html">JBEvent</a> *event)</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 <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#c0bb587450cabf4431d376a985b9694f">createMessage</a> (<a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a> type, const char *from, const char *to, const char *id, const char *message)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#f149efda34c8fb01c22b186f72783030">msgType</a> (const char *text)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#5300c440a8974025a3df6d6684890924">msgText</a> (<a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a> msg)</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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#5b48dd9cca4a273a60961848daf8377d">s_msg</a> []</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JBMessage.html#eb76442d8fb651cb95647bf4a0e7fb28">accept</a> (<a class="el" href="classTelEngine_1_1JBEvent.html">JBEvent</a> *event, bool &amp;processed, bool &amp;insert)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Jabber message service. 
<p>
This class is a message receiver service for the Jabber engine <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="2ea0bb09adcce7f655e8f8ee8d30561b"></a><!-- doxytag: member="TelEngine::JBMessage::MsgType" ref="2ea0bb09adcce7f655e8f8ee8d30561b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> type enumeration 
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c3c10ed9002c8c7bd02f3c9aed3cc019"></a><!-- doxytag: member="TelEngine::JBMessage::JBMessage" ref="c3c10ed9002c8c7bd02f3c9aed3cc019" args="(JBEngine *engine, const NamedList *params, int prio=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JBMessage.html">JBMessage</a>           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBEngine.html">JBEngine</a> *&nbsp;</td>
          <td class="paramname"> <em>engine</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> *&nbsp;</td>
          <td class="paramname"> <em>params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>prio</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. Constructs a Jabber message service <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>engine</em>&nbsp;</td><td>The Jabber engine </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>Service's parameters </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>prio</em>&nbsp;</td><td>The priority of this service </td></tr>
  </table>
</dl>

<p>References <a class="el" href="yatejabber_8h-source.html#l01143">JBThreadList::setOwner()</a>.</p>

</div>
</div><p>
<a class="anchor" name="d8bec1f689f893e40a11f7212c374143"></a><!-- doxytag: member="TelEngine::JBMessage::~JBMessage" ref="d8bec1f689f893e40a11f7212c374143" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1JBMessage.html">JBMessage</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor. Cancel private thread(s) 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="eb76442d8fb651cb95647bf4a0e7fb28"></a><!-- doxytag: member="TelEngine::JBMessage::accept" ref="eb76442d8fb651cb95647bf4a0e7fb28" args="(JBEvent *event, bool &amp;processed, bool &amp;insert)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool accept           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBEvent.html">JBEvent</a> *&nbsp;</td>
          <td class="paramname"> <em>event</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&nbsp;</td>
          <td class="paramname"> <em>processed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&nbsp;</td>
          <td class="paramname"> <em>insert</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Accept an event from the engine and process it if configured to do that <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to accept </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>processed</em>&nbsp;</td><td>Set to true on exit to signal that the event was already processed </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>insert</em>&nbsp;</td><td>Set to true if accepted to insert on top of the event queue </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if not accepted, let the engine try another service </dd></dl>

<p>Reimplemented from <a class="el" href="classTelEngine_1_1JBService.html#eb76442d8fb651cb95647bf4a0e7fb28">JBService</a>.</p>

</div>
</div><p>
<a class="anchor" name="c0bb587450cabf4431d376a985b9694f"></a><!-- doxytag: member="TelEngine::JBMessage::createMessage" ref="c0bb587450cabf4431d376a985b9694f" args="(MsgType type, const char *from, const char *to, const char *id, const char *message)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* createMessage           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>from</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>to</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>message</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a 'message' element <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> type as enumeration </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>from</em>&nbsp;</td><td>The 'from' attribute </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>to</em>&nbsp;</td><td>The 'to' attribute </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The 'id' attribute </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>The message body </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A valid <a class="el" href="classTelEngine_1_1XMLElement.html" title="An XML element.">XMLElement</a> pointer </dd></dl>

<p>Referenced by <a class="el" href="yatejingle_8h-source.html#l00444">JGSession::sendMessage()</a>.</p>

</div>
</div><p>
<a class="anchor" name="c9e7d1066fd09869137479a8442d28b3"></a><!-- doxytag: member="TelEngine::JBMessage::getMessage" ref="c9e7d1066fd09869137479a8442d28b3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1JBEvent.html">JBEvent</a>* getMessage           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a message from queue <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1JBEvent.html" title="A Jabber stream event.">JBEvent</a> pointer or 0 if no messages </dd></dl>

</div>
</div><p>
<a class="anchor" name="c391e1e7a016b4064486b5994fc1fed7"></a><!-- doxytag: member="TelEngine::JBMessage::initialize" ref="c391e1e7a016b4064486b5994fc1fed7" args="(const NamedList &amp;params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void initialize           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>params</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize the service <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>&nbsp;</td><td>Service's parameters </td></tr>
  </table>
</dl>

<p>Reimplemented from <a class="el" href="classTelEngine_1_1JBService.html#c391e1e7a016b4064486b5994fc1fed7">JBService</a>.</p>

</div>
</div><p>
<a class="anchor" name="5300c440a8974025a3df6d6684890924"></a><!-- doxytag: member="TelEngine::JBMessage::msgText" ref="5300c440a8974025a3df6d6684890924" args="(MsgType msg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static const char* msgText           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a>&nbsp;</td>
          <td class="paramname"> <em>msg</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the text from a message type <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>The message type </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The associated text or 0 </dd></dl>

<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>

</div>
</div><p>
<a class="anchor" name="f149efda34c8fb01c22b186f72783030"></a><!-- doxytag: member="TelEngine::JBMessage::msgType" ref="f149efda34c8fb01c22b186f72783030" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classTelEngine_1_1JBMessage.html#2ea0bb09adcce7f655e8f8ee8d30561b">MsgType</a> msgType           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the type of a 'message' stanza <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>The text to check </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> type as enumeration </dd></dl>

<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>

</div>
</div><p>
<a class="anchor" name="fcc65e410c45d66377d6a6d18679ec92"></a><!-- doxytag: member="TelEngine::JBMessage::processMessage" ref="fcc65e410c45d66377d6a6d18679ec92" args="(JBEvent *event)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void processMessage           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1JBEvent.html">JBEvent</a> *&nbsp;</td>
          <td class="paramname"> <em>event</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> processor. The derived classes must override this method to process received messages <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to process </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="5b48dd9cca4a273a60961848daf8377d"></a><!-- doxytag: member="TelEngine::JBMessage::s_msg" ref="5b48dd9cca4a273a60961848daf8377d" 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_1JBMessage.html#5b48dd9cca4a273a60961848daf8377d">s_msg</a>[]<code> [static]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Keep the types of 'message' stanzas 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatejabber_8h-source.html">yatejabber.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&nbsp;
<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional