1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
<HTML>
<HEAD>
<TITLE>class SIPEvent</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class SIPEvent</h1>
</TD>
<TD valign="top" align="right" colspan="1">A SIP event as retrieved from engine. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::SIPEvent</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___ysip___yatesip_h.html">libs/ysip/yatesip.h</A>></code></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SIPEvent.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref2">SIPEvent</A></b> ()
</LI>
<LI> <b><A HREF="#ref3">SIPEvent</A></b> (SIPMessage* message, SIPTransaction* transaction = 0)
</LI>
<LI> <b><A HREF="#ref4">~SIPEvent</A></b> ()
</LI>
<LI>inline SIPEngine* <b><A HREF="#ref5">getEngine</A></b> () const
</LI>
<LI>inline SIPMessage* <b><A HREF="#ref6">getMessage</A></b> () const
</LI>
<LI>inline SIPTransaction* <b><A HREF="#ref7">getTransaction</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref8">isOutgoing</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref9">isIncoming</A></b> () const
</LI>
<LI>inline SIPParty* <b><A HREF="#ref10">getParty</A></b> () const
</LI>
<LI>inline void* <b><A HREF="#ref11">getUserData</A></b> () const
</LI>
<LI>inline int <b><A HREF="#ref12">getState</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref13">isActive</A></b> () const
</LI>
</ul><h4>Protected Members</h4><ul><LI>SIPMessage* <b><A HREF="#ref14">m_message</A></b></LI>
<LI>SIPTransaction* <b><A HREF="#ref15">m_transaction</A></b></LI>
<LI>int <b><A HREF="#ref16">m_state</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This object is an event that will be taken from SIPEngine
</p>
<A NAME="SIPEvent"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SIPEvent</strong> ()
<br></td><td align="right"><h3><strong>SIPEvent</strong></h3></td></tr></table><p></p><A NAME="SIPEvent"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SIPEvent</strong> (SIPMessage* message, SIPTransaction* transaction = 0)
<br></td><td align="right"><h3><strong>SIPEvent</strong></h3></td></tr></table><p></p><A NAME="~SIPEvent"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~SIPEvent</strong> ()
<br></td><td align="right"><h3><strong>~SIPEvent</strong></h3></td></tr></table><p></p><A NAME="getEngine"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SIPEngine* <strong>getEngine</strong> ()
<br></td><td align="right"><h3><strong>getEngine</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the SIP engine this event belongs to, if any
</p>
<p><b>Returns</b>: Pointer to owning SIP engine or NULL
</p>
<A NAME="getMessage"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SIPMessage* <strong>getMessage</strong> ()
<br></td><td align="right"><h3><strong>getMessage</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the SIP message this event is supposed to handle
</p>
<p><b>Returns</b>: Pointer to SIP message causing the event
</p>
<A NAME="getTransaction"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SIPTransaction* <strong>getTransaction</strong> ()
<br></td><td align="right"><h3><strong>getTransaction</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the SIP transaction that generated the event, if any
</p>
<p><b>Returns</b>: Pointer to owning SIP transaction or NULL
</p>
<A NAME="isOutgoing"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>isOutgoing</strong> ()
<br></td><td align="right"><h3><strong>isOutgoing</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the message is an outgoing message
</p>
<p><b>Returns</b>: True if the message should be sent to remote
</p>
<A NAME="isIncoming"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>isIncoming</strong> ()
<br></td><td align="right"><h3><strong>isIncoming</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the message is an incoming message
</p>
<p><b>Returns</b>: True if the message is coming from remote
</p>
<A NAME="getParty"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SIPParty* <strong>getParty</strong> ()
<br></td><td align="right"><h3><strong>getParty</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the pointer to the endpoint this event uses
</p>
<A NAME="getUserData"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void* <strong>getUserData</strong> ()
<br></td><td align="right"><h3><strong>getUserData</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Return the opaque user data stored in the transaction
</p>
<A NAME="getState"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>getState</strong> ()
<br></td><td align="right"><h3><strong>getState</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
The state of the transaction when the event was generated
</p>
<A NAME="isActive"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>isActive</strong> ()
<br></td><td align="right"><h3><strong>isActive</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the transaction was active when the event was generated
</p>
<p><b>Returns</b>: True if the transaction was active, false if it finished
</p>
<A NAME="m_message"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPMessage* <strong>m_message</strong>
</td><td align="right"><h3><strong>m_message</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_transaction"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPTransaction* <strong>m_transaction</strong>
</td><td align="right"><h3><strong>m_transaction</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_state"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_state</strong>
</td><td align="right"><h3><strong>m_state</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
