<!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: MGCPEvent 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_1MGCPEvent.html">MGCPEvent</a> </div> </div> <div class="contents"> <h1>MGCPEvent Class Reference</h1><!-- doxytag: class="TelEngine::MGCPEvent" -->An MGCP event. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="yatemgcp_8h-source.html">yatemgcp.h</a>></code> <p> <p> <a href="classTelEngine_1_1MGCPEvent-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_1MGCPEvent.html#d6c16ca320eb8cfd313d92ed620ff757">~MGCPEvent</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1MGCPTransaction.html">MGCPTransaction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPEvent.html#df20c9bdd4d9770f07a73fc8ae4aeb0a">transaction</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPEvent.html#e6e8d06bb5eee00a9ef972a41d42e773">message</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_1MGCPEvent.html#8d080ef3a445832c3ad75470c3585ae9">MGCPEvent</a> (<a class="el" href="classTelEngine_1_1MGCPTransaction.html">MGCPTransaction</a> *trans, <a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a> *msg=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="6360421efa805d198b4c1849eacabcd7"></a><!-- doxytag: member="TelEngine::MGCPEvent::MGCPTransaction" ref="6360421efa805d198b4c1849eacabcd7" args="" --> class </td><td class="memItemRight" valign="bottom"><b>MGCPTransaction</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An MGCP event. <p> This class carries a copy of the message received by a transaction or a transaction state change notification (such as timeout or destroy) <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="d6c16ca320eb8cfd313d92ed620ff757"></a><!-- doxytag: member="TelEngine::MGCPEvent::~MGCPEvent" ref="d6c16ca320eb8cfd313d92ed620ff757" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">~<a class="el" href="classTelEngine_1_1MGCPEvent.html">MGCPEvent</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor. Delete the message. Notify and deref the transaction </div> </div><p> <a class="anchor" name="8d080ef3a445832c3ad75470c3585ae9"></a><!-- doxytag: member="TelEngine::MGCPEvent::MGCPEvent" ref="8d080ef3a445832c3ad75470c3585ae9" args="(MGCPTransaction *trans, MGCPMessage *msg=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1MGCPEvent.html">MGCPEvent</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1MGCPTransaction.html">MGCPTransaction</a> * </td> <td class="paramname"> <em>trans</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a> * </td> <td class="paramname"> <em>msg</em> = <code>0</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor. Constructs an event from a transaction <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>The transaction that generated this event </td></tr> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>The message carried by this event, if any </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="e6e8d06bb5eee00a9ef972a41d42e773"></a><!-- doxytag: member="TelEngine::MGCPEvent::message" ref="e6e8d06bb5eee00a9ef972a41d42e773" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a>* message </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the message carried by this event <dl class="return" compact><dt><b>Returns:</b></dt><dd>The message carried by this event or 0 if none </dd></dl> </div> </div><p> <a class="anchor" name="df20c9bdd4d9770f07a73fc8ae4aeb0a"></a><!-- doxytag: member="TelEngine::MGCPEvent::transaction" ref="df20c9bdd4d9770f07a73fc8ae4aeb0a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1MGCPTransaction.html">MGCPTransaction</a>* transaction </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the transaction that generated this event <dl class="return" compact><dt><b>Returns:</b></dt><dd>The transaction that generated this event </dd></dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="yatemgcp_8h-source.html">yatemgcp.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>