File: TelEngine__IAXFullFrame.html

package info (click to toggle)
yate 2.2.0-1~dfsg-1.1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 17,496 kB
  • ctags: 21,687
  • sloc: cpp: 126,248; ansic: 11,462; sh: 3,573; php: 3,229; python: 2,014; makefile: 1,504; perl: 465; awk: 8
file content (218 lines) | stat: -rw-r--r-- 11,595 bytes parent folder | download 
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
207
208
209
210
211
212
213
214
215
216
217
218
 
<HTML>
<HEAD>
<TITLE>class IAXFullFrame</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 IAXFullFrame</h1>
		</TD>
		<TD valign="top" align="right" colspan="1">This class holds an IAX full frame. <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>::IAXFullFrame</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include &lt;<A HREF="libs___yiax___yateiax_h.html">libs/yiax/yateiax.h</A>&gt;</code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__IAXFrame.html">TelEngine::IAXFrame</A> <small>[public ]</small></TD></TR>
<TR><TH>Inherited by</TH><TD><A HREF="TelEngine__IAXFrameOut.html">IAXFrameOut</A></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__IAXFullFrame.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="#ref1">ControlType</A> {        Hangup = 0x01,
        Ringing = 0x03,
        Answer = 0x04,
        Busy = 0x05,
        Congestion = 0x08,
        FlashHook = 0x09,
        Option = 0x0b,
        KeyRadio = 0x0c,
        UnkeyRadio = 0x0d,
        Progressing = 0x0e,
        Proceeding = 0x0f,
        Hold = 0x10,
        Unhold = 0x11,
        VidUpdate = 0x12,
    }
</LI>
</ul><h4>Public Methods</h4><ul><LI>&nbsp;<b><A HREF="#ref2">IAXFullFrame</A></b> (Type type, <A HREF="#u_int32_t">u_int32_t</A> subclass, <A HREF="#u_int16_t">u_int16_t</A> sCallNo, <A HREF="#u_int16_t">u_int16_t</A> dCallNo,
		 unsigned char oSeqNo, unsigned char iSeqNo,
		 <A HREF="#u_int32_t">u_int32_t</A> tStamp, bool retrans,
		 const unsigned char* buf, unsigned int len) 
</LI>
<LI>&nbsp;<b><A HREF="#ref3">IAXFullFrame</A></b> (Type type, <A HREF="#u_int32_t">u_int32_t</A> subclass, <A HREF="#u_int16_t">u_int16_t</A> sCallNo, <A HREF="#u_int16_t">u_int16_t</A> dCallNo,
		 unsigned char oSeqNo, unsigned char iSeqNo,
		 <A HREF="#u_int32_t">u_int32_t</A> tStamp,
		 const unsigned char* buf = 0, unsigned int len = 0) 
</LI>
<LI>virtual  &nbsp;<b><A HREF="#ref4">~IAXFullFrame</A></b> () 
</LI>
<LI>inline <A HREF="#u_int16_t">u_int16_t</A> &nbsp;<b><A HREF="#ref5">destCallNo</A></b> ()  const
</LI>
<LI>inline unsigned char &nbsp;<b><A HREF="#ref6">oSeqNo</A></b> ()  const
</LI>
<LI>inline unsigned char &nbsp;<b><A HREF="#ref7">iSeqNo</A></b> ()  const
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> &nbsp;<b><A HREF="#ref8">subclass</A></b> ()  const
</LI>
<LI>virtual  const IAXFullFrame* &nbsp;<b><A HREF="#ref9">fullFrame</A></b> ()  const
</LI>
<LI>void &nbsp;<b><A HREF="#ref10">toString</A></b> (String& dest, const SocketAddr& local, const SocketAddr& remote,
	bool incoming)  const
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static  inline const char* &nbsp;<b><A HREF="#ref11">controlTypeText</A></b> (int type) 
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
 This class holds all data needded to manage an IAX full frame
</p>
<A NAME="ControlType"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>ControlType</strong> {        Hangup = 0x01,
        Ringing = 0x03,
        Answer = 0x04,
        Busy = 0x05,
        Congestion = 0x08,
        FlashHook = 0x09,
        Option = 0x0b,
        KeyRadio = 0x0c,
        UnkeyRadio = 0x0d,
        Progressing = 0x0e,
        Proceeding = 0x0f,
        Hold = 0x10,
        Unhold = 0x11,
        VidUpdate = 0x12,
    }
</td><td align="right"><h3><strong>ControlType</strong></h3></td></tr></table><p></p><p>
 IAX frame subclass enumeration types for frames of type Control
     </p>
<A NAME="IAXFullFrame"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>IAXFullFrame</strong> (Type type, <A HREF="#u_int32_t">u_int32_t</A> subclass, <A HREF="#u_int16_t">u_int16_t</A> sCallNo, <A HREF="#u_int16_t">u_int16_t</A> dCallNo,
		 unsigned char oSeqNo, unsigned char iSeqNo,
		 <A HREF="#u_int32_t">u_int32_t</A> tStamp, bool retrans,
		 const unsigned char* buf, unsigned int len)
<br></td><td align="right"><h3><strong>IAXFullFrame</strong></h3></td></tr></table><p></p><p>
 Constructor. Constructs an incoming full frame
</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">Frame type
</TD></TR>
<TR><TD align="left" valign="top"><i>subclass</i></TD><TD align="left" valign="top">Frame subclass
</TD></TR>
<TR><TD align="left" valign="top"><i>sCallNo</i></TD><TD align="left" valign="top">Source (remote) call number
</TD></TR>
<TR><TD align="left" valign="top"><i>dCallNo</i></TD><TD align="left" valign="top">Destination (local) call number
</TD></TR>
<TR><TD align="left" valign="top"><i>oSeqNo</i></TD><TD align="left" valign="top">Outgoing sequence number
</TD></TR>
<TR><TD align="left" valign="top"><i>iSeqNo</i></TD><TD align="left" valign="top">Incoming (expected) sequence number
</TD></TR>
<TR><TD align="left" valign="top"><i>tStamp</i></TD><TD align="left" valign="top">Frame timestamp
</TD></TR>
<TR><TD align="left" valign="top"><i>retrans</i></TD><TD align="left" valign="top">Retransmission flag
</TD></TR>
<TR><TD align="left" valign="top"><i>buf</i></TD><TD align="left" valign="top">IE buffer
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">IE buffer length
     </TD></TR>
</TABLE></P>
<A NAME="IAXFullFrame"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>IAXFullFrame</strong> (Type type, <A HREF="#u_int32_t">u_int32_t</A> subclass, <A HREF="#u_int16_t">u_int16_t</A> sCallNo, <A HREF="#u_int16_t">u_int16_t</A> dCallNo,
		 unsigned char oSeqNo, unsigned char iSeqNo,
		 <A HREF="#u_int32_t">u_int32_t</A> tStamp,
		 const unsigned char* buf = 0, unsigned int len = 0)
<br></td><td align="right"><h3><strong>IAXFullFrame</strong></h3></td></tr></table><p></p><p>
 Constructor. Constructs an outgoing full frame
</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">Frame type
</TD></TR>
<TR><TD align="left" valign="top"><i>subclass</i></TD><TD align="left" valign="top">Frame subclass
</TD></TR>
<TR><TD align="left" valign="top"><i>sCallNo</i></TD><TD align="left" valign="top">Source (remote) call number
</TD></TR>
<TR><TD align="left" valign="top"><i>dCallNo</i></TD><TD align="left" valign="top">Destination (local) call number
</TD></TR>
<TR><TD align="left" valign="top"><i>oSeqNo</i></TD><TD align="left" valign="top">Outgoing sequence number
</TD></TR>
<TR><TD align="left" valign="top"><i>iSeqNo</i></TD><TD align="left" valign="top">Incoming (expected) sequence number
</TD></TR>
<TR><TD align="left" valign="top"><i>tStamp</i></TD><TD align="left" valign="top">Frame timestamp
</TD></TR>
<TR><TD align="left" valign="top"><i>buf</i></TD><TD align="left" valign="top">IE buffer
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">IE buffer length
     </TD></TR>
</TABLE></P>
<A NAME="~IAXFullFrame"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> &nbsp;<strong>~IAXFullFrame</strong> ()
<br></td><td align="right"><h3><strong>~IAXFullFrame</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 Destructor
     </p>
<A NAME="destCallNo"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int16_t">u_int16_t</A> &nbsp;<strong>destCallNo</strong> ()
<br></td><td align="right"><h3><strong>destCallNo</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the destination call number
</p>
<p><b>Returns</b>: The destination call number
     </p>
<A NAME="oSeqNo"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char &nbsp;<strong>oSeqNo</strong> ()
<br></td><td align="right"><h3><strong>oSeqNo</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the outgoing sequence number
</p>
<p><b>Returns</b>: The outgoing sequence number
     </p>
<A NAME="iSeqNo"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char &nbsp;<strong>iSeqNo</strong> ()
<br></td><td align="right"><h3><strong>iSeqNo</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the incoming sequence number
</p>
<p><b>Returns</b>: The incoming sequence number
     </p>
<A NAME="subclass"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> &nbsp;<strong>subclass</strong> ()
<br></td><td align="right"><h3><strong>subclass</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the subclass of this frame
</p>
<p><b>Returns</b>: The subclass of this frame
     </p>
<A NAME="fullFrame"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const IAXFullFrame* &nbsp;<strong>fullFrame</strong> ()
<br></td><td align="right"><h3><strong>fullFrame</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
 Get a pointer to this frame if it is a full frame
</p>
<p><b>Returns</b>: A pointer to this frame
     </p>
<p>Reimplemented from <A HREF="TelEngine__IAXFrame.html#fullFrame">IAXFrame</A>.</p>
<A NAME="toString"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>toString</strong> (String& dest, const SocketAddr& local, const SocketAddr& remote,
	bool incoming)
<br></td><td align="right"><h3><strong>toString</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Fill a string with this frame
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dest</i></TD><TD align="left" valign="top">The string to fill
</TD></TR>
<TR><TD align="left" valign="top"><i>local</i></TD><TD align="left" valign="top">The local address
</TD></TR>
<TR><TD align="left" valign="top"><i>remote</i></TD><TD align="left" valign="top">The remote address
</TD></TR>
<TR><TD align="left" valign="top"><i>incoming</i></TD><TD align="left" valign="top">True if it is an incoming frame
     </TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__GenObject.html#toString">GenObject</A>.</p>
<A NAME="controlTypeText"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> inline const char* &nbsp;<strong>controlTypeText</strong> (int type)
<br></td><td align="right"><h3><strong>controlTypeText</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
 Get the string associated with the given IAX control type
</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">The requested control type
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The text if type is valid or 0
     </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>