<!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: SIPEvent 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_1SIPEvent.html">SIPEvent</a>
</div>
</div>
<div class="contents">
<h1>SIPEvent Class Reference</h1><!-- doxytag: class="TelEngine::SIPEvent" --><code>#include <<a class="el" href="yatesip_8h-source.html">yatesip.h</a>></code>
<p>
<p>
<a href="classTelEngine_1_1SIPEvent-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"><a class="anchor" name="a27c7bbc1b46807469f24112fb623662"></a><!-- doxytag: member="TelEngine::SIPEvent::SIPEvent" ref="a27c7bbc1b46807469f24112fb623662" args="(SIPMessage *message, SIPTransaction *transaction=0)" -->
</td><td class="memItemRight" valign="bottom"><b>SIPEvent</b> (<a class="el" href="classTelEngine_1_1SIPMessage.html">SIPMessage</a> *message, <a class="el" href="classTelEngine_1_1SIPTransaction.html">SIPTransaction</a> *transaction=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SIPEngine.html">SIPEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#e7683d950ee47891da9c567602604a19">getEngine</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1SIPMessage.html">SIPMessage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#7a21fdba57b701043b2dbfdd9b74a708">getMessage</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SIPTransaction.html">SIPTransaction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#60ca4ba659f1b042f5efc4af90bfec18">getTransaction</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#07940f718d7777b6870e84d4f027e709">isOutgoing</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#c7b578c32ac980a62fd845aa40dab5cd">isIncoming</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">SIPParty * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#33186253139762b44994ab8f32ab4838">getParty</a> () 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_1SIPEvent.html#7ead208cc3c358a799bef54f4529548e">getUserData</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#f63e8c613d15b5563db86658d38ddab8">getState</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIPEvent.html#22761609071413dcce0632885c820e87">isActive</a> () const </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="196dff66b91bf39b3b53b751a5e920c0"></a><!-- doxytag: member="TelEngine::SIPEvent::m_message" ref="196dff66b91bf39b3b53b751a5e920c0" args="" -->
<a class="el" href="classTelEngine_1_1SIPMessage.html">SIPMessage</a> * </td><td class="memItemRight" valign="bottom"><b>m_message</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5ca3a16b28409f5b6a233014059b7d4"></a><!-- doxytag: member="TelEngine::SIPEvent::m_transaction" ref="b5ca3a16b28409f5b6a233014059b7d4" args="" -->
<a class="el" href="classTelEngine_1_1SIPTransaction.html">SIPTransaction</a> * </td><td class="memItemRight" valign="bottom"><b>m_transaction</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc4f94200981f2eb41a7df212afc1093"></a><!-- doxytag: member="TelEngine::SIPEvent::m_state" ref="cc4f94200981f2eb41a7df212afc1093" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_state</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="a3011f6f6942c70b0610cd300545dffb"></a><!-- doxytag: member="TelEngine::SIPEvent::SIPTransaction" ref="a3011f6f6942c70b0610cd300545dffb" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>SIPTransaction</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This object is an event that will be taken from <a class="el" href="classTelEngine_1_1SIPEngine.html">SIPEngine</a> <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e7683d950ee47891da9c567602604a19"></a><!-- doxytag: member="TelEngine::SIPEvent::getEngine" ref="e7683d950ee47891da9c567602604a19" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SIPEngine.html">SIPEngine</a>* getEngine </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The SIP engine this event belongs to, if any
</div>
</div><p>
<a class="anchor" name="7a21fdba57b701043b2dbfdd9b74a708"></a><!-- doxytag: member="TelEngine::SIPEvent::getMessage" ref="7a21fdba57b701043b2dbfdd9b74a708" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1SIPMessage.html">SIPMessage</a>* getMessage </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The SIP message this event is supposed to handle
</div>
</div><p>
<a class="anchor" name="33186253139762b44994ab8f32ab4838"></a><!-- doxytag: member="TelEngine::SIPEvent::getParty" ref="33186253139762b44994ab8f32ab4838" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SIPParty* getParty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the pointer to the endpoint this event uses
</div>
</div><p>
<a class="anchor" name="f63e8c613d15b5563db86658d38ddab8"></a><!-- doxytag: member="TelEngine::SIPEvent::getState" ref="f63e8c613d15b5563db86658d38ddab8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getState </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The state of the transaction when the event was generated
</div>
</div><p>
<a class="anchor" name="60ca4ba659f1b042f5efc4af90bfec18"></a><!-- doxytag: member="TelEngine::SIPEvent::getTransaction" ref="60ca4ba659f1b042f5efc4af90bfec18" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SIPTransaction.html">SIPTransaction</a>* getTransaction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The SIP transaction that gererated the event, if any
</div>
</div><p>
<a class="anchor" name="7ead208cc3c358a799bef54f4529548e"></a><!-- doxytag: member="TelEngine::SIPEvent::getUserData" ref="7ead208cc3c358a799bef54f4529548e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* getUserData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the opaque user data stored in the transaction
</div>
</div><p>
<a class="anchor" name="22761609071413dcce0632885c820e87"></a><!-- doxytag: member="TelEngine::SIPEvent::isActive" ref="22761609071413dcce0632885c820e87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isActive </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the transaction was active when the event was generated <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the transaction was active, false if it finished </dd></dl>
</div>
</div><p>
<a class="anchor" name="c7b578c32ac980a62fd845aa40dab5cd"></a><!-- doxytag: member="TelEngine::SIPEvent::isIncoming" ref="c7b578c32ac980a62fd845aa40dab5cd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isIncoming </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the message is an incoming message <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the message is coming from remote </dd></dl>
</div>
</div><p>
<a class="anchor" name="07940f718d7777b6870e84d4f027e709"></a><!-- doxytag: member="TelEngine::SIPEvent::isOutgoing" ref="07940f718d7777b6870e84d4f027e709" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isOutgoing </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the message is an outgoing message <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the message should be sent to remote </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatesip_8h-source.html">yatesip.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:14 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
>
443
