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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
<HTML>
<HEAD>
<TITLE>class RTPBaseIO</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 RTPBaseIO</h1>
</TD>
<TD valign="top" align="right" colspan="1">Common send/recv variables holder. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH colspan="2">Contains pure virtuals</TH></TR><TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::RTPBaseIO</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___yrtp___yatertp_h.html">libs/yrtp/yatertp.h</A>></code></TD></TR>
<TR><TH>Inherited by</TH><TD><A HREF="TelEngine__RTPReceiver.html">RTPReceiver</A>, <A HREF="TelEngine__RTPSender.html">RTPSender</A></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__RTPBaseIO.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>inline <b><A HREF="#ref3">RTPBaseIO</A></b> (RTPSession* session = 0)
</LI>
<LI>virtual <b><A HREF="#ref4">~RTPBaseIO</A></b> ()
</LI>
<LI>inline int <b><A HREF="#ref5">dataPayload</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref6">dataPayload</A></b> (int type)
</LI>
<LI>inline int <b><A HREF="#ref7">eventPayload</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref8">eventPayload</A></b> (int type)
</LI>
<LI>inline int <b><A HREF="#ref9">silencePayload</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref10">silencePayload</A></b> (int type)
</LI>
<LI>unsigned int <b><A HREF="#ref11">ssrcInit</A></b> ()
</LI>
<LI>inline void <b><A HREF="#ref12">reset</A></b> ()
</LI>
<LI>inline unsigned int <b><A HREF="#ref13">ssrc</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref14">ssrc</A></b> (unsigned int src)
</LI>
<LI>inline <A HREF="#u_int16_t">u_int16_t</A> <b><A HREF="#ref15">seq</A></b> () const
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> <b><A HREF="#ref16">rollover</A></b> () const
</LI>
<LI>inline <A HREF="#u_int64_t">u_int64_t</A> <b><A HREF="#ref17">fullSeq</A></b> () const
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> <b><A HREF="#ref18">ioPackets</A></b> () const
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> <b><A HREF="#ref19">ioOctets</A></b> () const
</LI>
<LI>inline RTPSession* <b><A HREF="#ref20">session</A></b> () const
</LI>
<LI>inline RTPSecure* <b><A HREF="#ref21">security</A></b> () const
</LI>
<LI>void <b><A HREF="#ref22">security</A></b> (RTPSecure* secure)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><i><A HREF="#ref23">timerTick</A></i></b> (const Time& when)
</LI>
<LI>inline void <b><A HREF="#ref24">secLength</A></b> (<A HREF="#u_int32_t">u_int32_t</A> len, <A HREF="#u_int32_t">u_int32_t</A> key = 0)
</LI>
</ul><h4>Protected Members</h4><ul><LI>RTPSession* <b><A HREF="#ref25">m_session</A></b></LI>
<LI>RTPSecure* <b><A HREF="#ref26">m_secure</A></b></LI>
<LI>bool <b><A HREF="#ref27">m_ssrcInit</A></b></LI>
<LI>u_int32_t <b><A HREF="#ref28">m_ssrc</A></b></LI>
<LI>u_int32_t <b><A HREF="#ref29">m_ts</A></b></LI>
<LI>u_int16_t <b><A HREF="#ref30">m_seq</A></b></LI>
<LI>u_int32_t <b><A HREF="#ref31">m_rollover</A></b></LI>
<LI>u_int16_t <b><A HREF="#ref32">m_secLen</A></b></LI>
<LI>u_int16_t <b><A HREF="#ref33">m_mkiLen</A></b></LI>
<LI>u_int32_t <b><A HREF="#ref34">m_evTs</A></b></LI>
<LI>int <b><A HREF="#ref35">m_evNum</A></b></LI>
<LI>int <b><A HREF="#ref36">m_evVol</A></b></LI>
<LI>u_int32_t <b><A HREF="#ref37">m_ioPackets</A></b></LI>
<LI>u_int32_t <b><A HREF="#ref38">m_ioOctets</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Base class that holds common sender and receiver methods
</p>
<A NAME="RTPBaseIO"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>RTPBaseIO</strong> (RTPSession* session = 0)
<br></td><td align="right"><h3><strong>RTPBaseIO</strong></h3></td></tr></table><p></p><p>
Default constructor.
</p>
<A NAME="~RTPBaseIO"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~RTPBaseIO</strong> ()
<br></td><td align="right"><h3><strong>~RTPBaseIO</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="dataPayload"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>dataPayload</strong> ()
<br></td><td align="right"><h3><strong>dataPayload</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the payload type for data packets
</p>
<p><b>Returns</b>: Payload type, -1 if not set
</p>
<A NAME="dataPayload"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>dataPayload</strong> (int type)
<br></td><td align="right"><h3><strong>dataPayload</strong></h3></td></tr></table><p></p><p>
Set the payload type for data packets
</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">Payload type, -1 to disable
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if changed, false if invalid payload type
</p>
<A NAME="eventPayload"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>eventPayload</strong> ()
<br></td><td align="right"><h3><strong>eventPayload</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the payload type for event packets
</p>
<p><b>Returns</b>: Payload type, -1 if not set
</p>
<A NAME="eventPayload"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>eventPayload</strong> (int type)
<br></td><td align="right"><h3><strong>eventPayload</strong></h3></td></tr></table><p></p><p>
Set the payload type for event packets
</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">Payload type, -1 to disable
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if changed, false if invalid payload type
</p>
<A NAME="silencePayload"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>silencePayload</strong> ()
<br></td><td align="right"><h3><strong>silencePayload</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the payload type for Silence event packets
</p>
<p><b>Returns</b>: Payload type, -1 if not set
</p>
<A NAME="silencePayload"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>silencePayload</strong> (int type)
<br></td><td align="right"><h3><strong>silencePayload</strong></h3></td></tr></table><p></p><p>
Set the payload type for Silence event packets.
Thanks, Silence, for a new and incompatible way of sending events.
</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">Payload type, -1 to disable
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if changed, false if invalid payload type
</p>
<A NAME="ssrcInit"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int <strong>ssrcInit</strong> ()
<br></td><td align="right"><h3><strong>ssrcInit</strong></h3></td></tr></table><p></p><p>
Return SSRC value, initialize to a new, random value if needed
</p>
<p><b>Returns</b>: Current value of SSRC
</p>
<A NAME="reset"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>reset</strong> ()
<br></td><td align="right"><h3><strong>reset</strong></h3></td></tr></table><p></p><p>
Requesting generation/grabbing of a new SSRC
</p>
<A NAME="ssrc"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned int <strong>ssrc</strong> ()
<br></td><td align="right"><h3><strong>ssrc</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the value of the current SSRC, zero if not initialized yet
</p>
<p><b>Returns</b>: Value of SSRC, zero if not initialized
</p>
<A NAME="ssrc"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>ssrc</strong> (unsigned int src)
<br></td><td align="right"><h3><strong>ssrc</strong></h3></td></tr></table><p></p><p>
Force a new known SSRC for all further packets
</p>
<A NAME="seq"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int16_t">u_int16_t</A> <strong>seq</strong> ()
<br></td><td align="right"><h3><strong>seq</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the current sequence number
</p>
<p><b>Returns</b>: Sequence number
</p>
<A NAME="rollover"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> <strong>rollover</strong> ()
<br></td><td align="right"><h3><strong>rollover</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the value of the rollover counter
</p>
<p><b>Returns</b>: How many times the seqeunce has rolled over since SSRC changed
</p>
<A NAME="fullSeq"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int64_t">u_int64_t</A> <strong>fullSeq</strong> ()
<br></td><td align="right"><h3><strong>fullSeq</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the full current sequence number including rollovers
</p>
<p><b>Returns</b>: Full 48 bit current sequence number
</p>
<A NAME="ioPackets"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> <strong>ioPackets</strong> ()
<br></td><td align="right"><h3><strong>ioPackets</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrieve the number of packets exchanged on current session
</p>
<p><b>Returns</b>: Number of packets exchanged
</p>
<A NAME="ioOctets"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> <strong>ioOctets</strong> ()
<br></td><td align="right"><h3><strong>ioOctets</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrieve the number of payload octets exchanged on current session
</p>
<p><b>Returns</b>: Number of octets exchanged except headers and padding
</p>
<A NAME="session"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RTPSession* <strong>session</strong> ()
<br></td><td align="right"><h3><strong>session</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the session this object belongs to
</p>
<p><b>Returns</b>: Pointer to RTP session or NULL
</p>
<A NAME="security"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RTPSecure* <strong>security</strong> ()
<br></td><td align="right"><h3><strong>security</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the security provider of this sender or receiver
</p>
<p><b>Returns</b>: A pointer to the RTPSecure or NULL
</p>
<A NAME="security"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>security</strong> (RTPSecure* secure)
<br></td><td align="right"><h3><strong>security</strong></h3></td></tr></table><p></p><p>
Set the security provider of this sender or receiver
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>secure</i></TD><TD align="left" valign="top">Pointer to the new RTPSecure or NULL
</TD></TR>
</TABLE></P>
<A NAME="timerTick"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <i><strong>timerTick</strong></i> (const Time& when)
<br></td><td align="right"><h3><i><strong>timerTick</strong></i></h3></td></tr></table><p> <small>[protected pure virtual]</small></p><p>
Method called periodically to keep the data flowing
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>when</i></TD><TD align="left" valign="top">Time to use as base in all computing
</TD></TR>
</TABLE></P>
<A NAME="secLength"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>secLength</strong> (<A HREF="#u_int32_t">u_int32_t</A> len, <A HREF="#u_int32_t">u_int32_t</A> key = 0)
<br></td><td align="right"><h3><strong>secLength</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Set the length of the added / expected security info block
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of security information portion
</TD></TR>
<TR><TD align="left" valign="top"><i>key</i></TD><TD align="left" valign="top">Length of master key identifier
</TD></TR>
</TABLE></P>
<A NAME="m_session"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td>RTPSession* <strong>m_session</strong>
</td><td align="right"><h3><strong>m_session</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_secure"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td>RTPSecure* <strong>m_secure</strong>
</td><td align="right"><h3><strong>m_secure</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_ssrcInit"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_ssrcInit</strong>
</td><td align="right"><h3><strong>m_ssrcInit</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_ssrc"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int32_t">u_int32_t</A> <strong>m_ssrc</strong>
</td><td align="right"><h3><strong>m_ssrc</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_ts"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int32_t">u_int32_t</A> <strong>m_ts</strong>
</td><td align="right"><h3><strong>m_ts</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_seq"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int16_t">u_int16_t</A> <strong>m_seq</strong>
</td><td align="right"><h3><strong>m_seq</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_rollover"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int32_t">u_int32_t</A> <strong>m_rollover</strong>
</td><td align="right"><h3><strong>m_rollover</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_secLen"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int16_t">u_int16_t</A> <strong>m_secLen</strong>
</td><td align="right"><h3><strong>m_secLen</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_mkiLen"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int16_t">u_int16_t</A> <strong>m_mkiLen</strong>
</td><td align="right"><h3><strong>m_mkiLen</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_evTs"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int32_t">u_int32_t</A> <strong>m_evTs</strong>
</td><td align="right"><h3><strong>m_evTs</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_evNum"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_evNum</strong>
</td><td align="right"><h3><strong>m_evNum</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_evVol"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_evVol</strong>
</td><td align="right"><h3><strong>m_evVol</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_ioPackets"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int32_t">u_int32_t</A> <strong>m_ioPackets</strong>
</td><td align="right"><h3><strong>m_ioPackets</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_ioOctets"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int32_t">u_int32_t</A> <strong>m_ioOctets</strong>
</td><td align="right"><h3><strong>m_ioOctets</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>
|
