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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
<HTML>
<HEAD>
<TITLE>class IAXEvent</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 IAXEvent</h1>
</TD>
<TD valign="top" align="right" colspan="1">Event class. <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>::IAXEvent</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___yiax___yateiax_h.html">libs/yiax/yateiax.h</A>></code></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__IAXEvent.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 Types</h4><ul><LI>enum <A HREF="#ref3">Type</A> { Invalid = 0,
Terminated,
Timeout,
NotImplemented,
New,
AuthReq,
AuthRep,
Accept,
Hangup,
Reject,
Busy,
Text,
Dtmf,
Noise,
Answer,
Quelch,
Unquelch,
Progressing,
Ringing,
}
</LI>
</ul><h4>Public Methods</h4><ul><LI> <b><A HREF="#ref4">~IAXEvent</A></b> ()
</LI>
<LI>inline Type <b><A HREF="#ref5">type</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref6">local</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref7">final</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref8">setFinal</A></b> ()
</LI>
<LI>inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref9">frameType</A></b> ()
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> <b><A HREF="#ref10">subclass</A></b> ()
</LI>
<LI>inline IAXEngine* <b><A HREF="#ref11">getEngine</A></b> () const
</LI>
<LI>inline IAXTransaction* <b><A HREF="#ref12">getTransaction</A></b> () const
</LI>
<LI>inline void* <b><A HREF="#ref13">getUserData</A></b> () const
</LI>
<LI>inline IAXIEList& <b><A HREF="#ref14">getList</A></b> ()
</LI>
</ul><h4>Protected Methods</h4><ul><LI> <b><A HREF="#ref15">IAXEvent</A></b> (Type type, bool local, bool final, IAXTransaction* transaction, <A HREF="#u_int8_t">u_int8_t</A> frameType = 0, <A HREF="#u_int32_t">u_int32_t</A> subclass = 0)
</LI>
<LI> <b><A HREF="#ref16">IAXEvent</A></b> (Type type, bool local, bool final, IAXTransaction* transaction, const IAXFullFrame* frame = 0)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class holds an event generated by a transaction
</p>
<A NAME="Type"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Type</strong> { Invalid = 0,
Terminated,
Timeout,
NotImplemented,
New,
AuthReq,
AuthRep,
Accept,
Hangup,
Reject,
Busy,
Text,
Dtmf,
Noise,
Answer,
Quelch,
Unquelch,
Progressing,
Ringing,
}
</td><td align="right"><h3><strong>Type</strong></h3></td></tr></table><p></p><p>
Event type as enumeration
</p>
<A NAME="~IAXEvent"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~IAXEvent</strong> ()
<br></td><td align="right"><h3><strong>~IAXEvent</strong></h3></td></tr></table><p></p><p>
Destructor
Dereferences the transaction possibly causing its destruction
</p>
<A NAME="type"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline Type <strong>type</strong> ()
<br></td><td align="right"><h3><strong>type</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the type of this event
</p>
<p><b>Returns</b>: The type of the event as enumeratio
</p>
<A NAME="local"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>local</strong> ()
<br></td><td align="right"><h3><strong>local</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this is a locally generated event
</p>
<p><b>Returns</b>: True if it is a locally generated event
</p>
<A NAME="final"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>final</strong> ()
<br></td><td align="right"><h3><strong>final</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this is a transaction finalization event
</p>
<p><b>Returns</b>: True if the transaction has finalized and will be destroyed
</p>
<A NAME="setFinal"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>setFinal</strong> ()
<br></td><td align="right"><h3><strong>setFinal</strong></h3></td></tr></table><p></p><p>
Set the final flag.
</p>
<A NAME="frameType"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>frameType</strong> ()
<br></td><td align="right"><h3><strong>frameType</strong></h3></td></tr></table><p></p><p>
Get the type of the frame that generated the event
If 0 (internal event), the event consumer must delete the event
</p>
<p><b>Returns</b>: Frame type
</p>
<A NAME="subclass"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> <strong>subclass</strong> ()
<br></td><td align="right"><h3><strong>subclass</strong></h3></td></tr></table><p></p><p>
Get the subclass of the frame that generated the event
</p>
<p><b>Returns</b>: Frame subclass
</p>
<A NAME="getEngine"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline IAXEngine* <strong>getEngine</strong> ()
<br></td><td align="right"><h3><strong>getEngine</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the IAX engine this event belongs to, if any
</p>
<p><b>Returns</b>: The IAX engine this event belongs to, if any
</p>
<A NAME="getTransaction"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline IAXTransaction* <strong>getTransaction</strong> ()
<br></td><td align="right"><h3><strong>getTransaction</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the IAX transaction that generated the event, if any
</p>
<p><b>Returns</b>: The IAX transaction that generated the event, if any
</p>
<A NAME="getUserData"></A><A NAME="ref13"></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>
Get the opaque user data stored in the transaction
</p>
<p><b>Returns</b>: The opaque user data stored in the transaction
</p>
<A NAME="getList"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline IAXIEList& <strong>getList</strong> ()
<br></td><td align="right"><h3><strong>getList</strong></h3></td></tr></table><p></p><p>
Get the IE list
</p>
<p><b>Returns</b>: IE list reference
</p>
<A NAME="IAXEvent"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>IAXEvent</strong> (Type type, bool local, bool final, IAXTransaction* transaction, <A HREF="#u_int8_t">u_int8_t</A> frameType = 0, <A HREF="#u_int32_t">u_int32_t</A> subclass = 0)
<br></td><td align="right"><h3><strong>IAXEvent</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Event type
</TD></TR>
<TR><TD align="left" valign="top"><i>local</i></TD><TD align="left" valign="top">Local flag
</TD></TR>
<TR><TD align="left" valign="top"><i>final</i></TD><TD align="left" valign="top">Final flag
</TD></TR>
<TR><TD align="left" valign="top"><i>transaction</i></TD><TD align="left" valign="top">IAX transaction that generated the event
</TD></TR>
<TR><TD align="left" valign="top"><i>frameType</i></TD><TD align="left" valign="top">The type of the frame that generated the event
</TD></TR>
<TR><TD align="left" valign="top"><i>subclass</i></TD><TD align="left" valign="top">The subclass of the frame that generated the event
</TD></TR>
</TABLE></P>
<A NAME="IAXEvent"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>IAXEvent</strong> (Type type, bool local, bool final, IAXTransaction* transaction, const IAXFullFrame* frame = 0)
<br></td><td align="right"><h3><strong>IAXEvent</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Event type
</TD></TR>
<TR><TD align="left" valign="top"><i>local</i></TD><TD align="left" valign="top">Local flag
</TD></TR>
<TR><TD align="left" valign="top"><i>final</i></TD><TD align="left" valign="top">Final flag
</TD></TR>
<TR><TD align="left" valign="top"><i>transaction</i></TD><TD align="left" valign="top">IAX transaction that generated the event
</TD></TR>
<TR><TD align="left" valign="top"><i>frame</i></TD><TD align="left" valign="top">The frame that generated the event
</TD></TR>
</TABLE></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>
|
