<!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: JGEvent 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_1JGEvent.html">JGEvent</a>
</div>
</div>
<div class="contents">
<h1>JGEvent Class Reference</h1><!-- doxytag: class="TelEngine::JGEvent" -->A Jingle event.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatejingle_8h-source.html">yatejingle.h</a>></code>
<p>
<p>
<a href="classTelEngine_1_1JGEvent-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_1JGEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <b>Jingle</b>,
<b>Terminated</b>,
<b>Destroy</b>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#d717a07aa5f4c6489ba6bb788445cc14">~JGEvent</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JGEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#fbd0fa31db28593e9669c3c56711c0a7">type</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JGSession.html">JGSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#250976eeb667f83340f1a961fc0cf93a">session</a> () const </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_1JGEvent.html#097b09ca0cd260fcdb0f05c34473847c">element</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JGSession.html#8bb1ef53467e4f61410d12822d922498">JGSession::Action</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#3f7fe152abb15d001ac176114964f327">action</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1JGAudioList.html">JGAudioList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#3598ed3af10ef068657b65f95089bcd5">audio</a> ()</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_1JGEvent.html#fd3d48785af7f3a0d79c89e336129c7e">transport</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#e537a056a2d8316444575696aa701bbd">id</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#4e3addfdb1af4d3a2d4716a6343921ea">reason</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#b9dd7ce5697473f1226828da52353f6b">text</a> () const </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_1JGEvent.html#6ce67cd364c3a85ec5c63c629e18d8a2">releaseXML</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_1JGEvent.html#32921c16f78fbf22e8f553ec5d355285">final</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected 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_1JGEvent.html#832a932e8af0013b89f2ffe03dadf7f4">JGEvent</a> (<a class="el" href="classTelEngine_1_1JGEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type, <a class="el" href="classTelEngine_1_1JGSession.html">JGSession</a> *session, <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *element=0, const char *reason=0, const char *text=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGEvent.html#8a9a308ab51ad7c5957241a74203a8d4">JGEvent</a> (<a class="el" href="classTelEngine_1_1JGSession.html#8bb1ef53467e4f61410d12822d922498">JGSession::Action</a> act, <a class="el" href="classTelEngine_1_1JGSession.html">JGSession</a> *session, <a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *element, const char *reason=0, const char *text=0)</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="0b292114c6d25e1e8deda6cc4d9e55a6"></a><!-- doxytag: member="TelEngine::JGEvent::JGSession" ref="0b292114c6d25e1e8deda6cc4d9e55a6" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>JGSession</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Jingle event.
<p>
This class holds an event generated by a Jingle session <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="TelEngine::JGEvent::Type" ref="1d1cfd8ffb84e947f82999c682b666a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1JGEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Jingle events enumeration
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d717a07aa5f4c6489ba6bb788445cc14"></a><!-- doxytag: member="TelEngine::JGEvent::~JGEvent" ref="d717a07aa5f4c6489ba6bb788445cc14" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1JGEvent.html">JGEvent</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor. Deref the session. Delete the XML element
</div>
</div><p>
<a class="anchor" name="832a932e8af0013b89f2ffe03dadf7f4"></a><!-- doxytag: member="TelEngine::JGEvent::JGEvent" ref="832a932e8af0013b89f2ffe03dadf7f4" args="(Type type, JGSession *session, XMLElement *element=0, const char *reason=0, const char *text=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JGEvent.html">JGEvent</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JGEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JGSession.html">JGSession</a> * </td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td>
<td class="paramname"> <em>element</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>reason</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Set the id parameter if the element is valid <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> </td><td>Event type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>The session that generated this event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>element</em> </td><td>Optional XML element that generated this event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>Optional reason data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>Optional text data </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8a9a308ab51ad7c5957241a74203a8d4"></a><!-- doxytag: member="TelEngine::JGEvent::JGEvent" ref="8a9a308ab51ad7c5957241a74203a8d4" args="(JGSession::Action act, JGSession *session, XMLElement *element, const char *reason=0, const char *text=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JGEvent.html">JGEvent</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JGSession.html#8bb1ef53467e4f61410d12822d922498">JGSession::Action</a> </td>
<td class="paramname"> <em>act</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1JGSession.html">JGSession</a> * </td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td>
<td class="paramname"> <em>element</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>reason</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Create a Jingle event. Set the id parameter if the element is valid <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>act</em> </td><td>The jingle action </td></tr>
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>The session that generated this event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>element</em> </td><td>XML element that generated this event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>Optional reason data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>Optional text data </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3f7fe152abb15d001ac176114964f327"></a><!-- doxytag: member="TelEngine::JGEvent::action" ref="3f7fe152abb15d001ac176114964f327" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JGSession.html#8bb1ef53467e4f61410d12822d922498">JGSession::Action</a> action </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the jingle action as enumeration <dl class="return" compact><dt><b>Returns:</b></dt><dd>The jingle action as enumeration </dd></dl>
</div>
</div><p>
<a class="anchor" name="3598ed3af10ef068657b65f95089bcd5"></a><!-- doxytag: member="TelEngine::JGEvent::audio" ref="3598ed3af10ef068657b65f95089bcd5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JGAudioList.html">JGAudioList</a>& audio </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the audio payloads list <dl class="return" compact><dt><b>Returns:</b></dt><dd>The audio payloads list </dd></dl>
</div>
</div><p>
<a class="anchor" name="097b09ca0cd260fcdb0f05c34473847c"></a><!-- doxytag: member="TelEngine::JGEvent::element" ref="097b09ca0cd260fcdb0f05c34473847c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* element </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the XML element that generated this event <dl class="return" compact><dt><b>Returns:</b></dt><dd>The XML element that generated this event </dd></dl>
</div>
</div><p>
<a class="anchor" name="32921c16f78fbf22e8f553ec5d355285"></a><!-- doxytag: member="TelEngine::JGEvent::final" ref="32921c16f78fbf22e8f553ec5d355285" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool final </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this event is a final one (Terminated or Destroy) <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it is </dd></dl>
</div>
</div><p>
<a class="anchor" name="e537a056a2d8316444575696aa701bbd"></a><!-- doxytag: member="TelEngine::JGEvent::id" ref="e537a056a2d8316444575696aa701bbd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</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 the id <dl class="return" compact><dt><b>Returns:</b></dt><dd>The id </dd></dl>
</div>
</div><p>
<a class="anchor" name="4e3addfdb1af4d3a2d4716a6343921ea"></a><!-- doxytag: member="TelEngine::JGEvent::reason" ref="4e3addfdb1af4d3a2d4716a6343921ea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& reason </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the reason <dl class="return" compact><dt><b>Returns:</b></dt><dd>The reason </dd></dl>
</div>
</div><p>
<a class="anchor" name="6ce67cd364c3a85ec5c63c629e18d8a2"></a><!-- doxytag: member="TelEngine::JGEvent::releaseXML" ref="6ce67cd364c3a85ec5c63c629e18d8a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* releaseXML </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the XML element that generated this event and set it to 0 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The XML element that generated this event </dd></dl>
</div>
</div><p>
<a class="anchor" name="250976eeb667f83340f1a961fc0cf93a"></a><!-- doxytag: member="TelEngine::JGEvent::session" ref="250976eeb667f83340f1a961fc0cf93a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JGSession.html">JGSession</a>* session </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the session that generated this event <dl class="return" compact><dt><b>Returns:</b></dt><dd>The session that generated this event </dd></dl>
</div>
</div><p>
<a class="anchor" name="b9dd7ce5697473f1226828da52353f6b"></a><!-- doxytag: member="TelEngine::JGEvent::text" ref="b9dd7ce5697473f1226828da52353f6b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& text </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the text <dl class="return" compact><dt><b>Returns:</b></dt><dd>The text </dd></dl>
</div>
</div><p>
<a class="anchor" name="fd3d48785af7f3a0d79c89e336129c7e"></a><!-- doxytag: member="TelEngine::JGEvent::transport" ref="fd3d48785af7f3a0d79c89e336129c7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a>& transport </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transports list <dl class="return" compact><dt><b>Returns:</b></dt><dd>The transports list </dd></dl>
</div>
</div><p>
<a class="anchor" name="fbd0fa31db28593e9669c3c56711c0a7"></a><!-- doxytag: member="TelEngine::JGEvent::type" ref="fbd0fa31db28593e9669c3c56711c0a7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JGEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of this event <dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of this event as enumeration </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatejingle_8h-source.html">yatejingle.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
>
259
