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
|
<HTML>
<HEAD>
<TITLE>class UDPSession</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 UDPSession</h1>
</TD>
<TD valign="top" align="right" colspan="1">RTP or UDPTL session. <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>::UDPSession</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>Inherits</TH><TD><i><A HREF="TelEngine__RTPProcessor.html">TelEngine::RTPProcessor</A></i> <small>[public ]</small></TD></TR>
<TR><TH>Inherited by</TH><TD><A HREF="TelEngine__RTPSession.html">RTPSession</A>, <i><A HREF="TelEngine__UDPTLSession.html">UDPTLSession</A></i></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__UDPSession.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>virtual <b><A HREF="#ref1">~UDPSession</A></b> ()
</LI>
<LI>virtual RTPTransport* <b><A HREF="#ref2">createTransport</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref3">initTransport</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref4">initGroup</A></b> (int msec = 0, Thread::Priority prio = Thread::Normal)
</LI>
<LI>inline bool <b><A HREF="#ref5">remoteAddr</A></b> (SocketAddr& addr, bool sniff = false)
</LI>
<LI>inline bool <b><A HREF="#ref6">setTOS</A></b> (int tos)
</LI>
<LI>inline Socket* <b><A HREF="#ref7">rtpSock</A></b> ()
</LI>
<LI>inline bool <b><A HREF="#ref8">drillHole</A></b> ()
</LI>
<LI>void <b><A HREF="#ref9">setTimeout</A></b> (int interval)
</LI>
<LI>inline RTPTransport* <b><A HREF="#ref10">transport</A></b> () const
</LI>
<LI>virtual void <b><A HREF="#ref11">transport</A></b> (RTPTransport* trans)
</LI>
</ul><h4>Protected Methods</h4><ul><LI> <b><A HREF="#ref12">UDPSession</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref13">timeout</A></b> (bool initial)
</LI>
</ul><h4>Protected Members</h4><ul><LI>RTPTransport* <b><A HREF="#ref14">m_transport</A></b></LI>
<LI>u_int64_t <b><A HREF="#ref15">m_timeoutTime</A></b></LI>
<LI>u_int64_t <b><A HREF="#ref16">m_timeoutInterval</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
A base class for RTP, SRTP or UDPTL sessions
</p>
<A NAME="~UDPSession"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~UDPSession</strong> ()
<br></td><td align="right"><h3><strong>~UDPSession</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor - cleans up any remaining resources
</p>
<A NAME="createTransport"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> RTPTransport* <strong>createTransport</strong> ()
<br></td><td align="right"><h3><strong>createTransport</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Create a new RTP or UDP transport for this session.
Override this method to create objects derived from RTPTransport.
</p>
<p><b>Returns</b>: Pointer to the new transport or NULL on failure
</p>
<A NAME="initTransport"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>initTransport</strong> ()
<br></td><td align="right"><h3><strong>initTransport</strong></h3></td></tr></table><p></p><p>
Initialize the RTP session, attach a transport if there is none
</p>
<p><b>Returns</b>: True if initialized, false on some failure
</p>
<A NAME="initGroup"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>initGroup</strong> (int msec = 0, Thread::Priority prio = Thread::Normal)
<br></td><td align="right"><h3><strong>initGroup</strong></h3></td></tr></table><p></p><p>
Initialize the RTP session, attach a group if none is present
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msec</i></TD><TD align="left" valign="top">Minimum time to sleep in group loop in milliseconds
</TD></TR>
<TR><TD align="left" valign="top"><i>prio</i></TD><TD align="left" valign="top">Thread priority to run the new group
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if initialized, false on some failure
</p>
<A NAME="remoteAddr"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>remoteAddr</strong> (SocketAddr& addr, bool sniff = false)
<br></td><td align="right"><h3><strong>remoteAddr</strong></h3></td></tr></table><p></p><p>
Set the remote network address of the RTP transport of this session
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>addr</i></TD><TD align="left" valign="top">New remote RTP transport address
</TD></TR>
<TR><TD align="left" valign="top"><i>sniff</i></TD><TD align="left" valign="top">Automatically adjust the address from the first incoming packet
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if address set, false if a failure occured
</p>
<A NAME="setTOS"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>setTOS</strong> (int tos)
<br></td><td align="right"><h3><strong>setTOS</strong></h3></td></tr></table><p></p><p>
Set the Type Of Service for the RTP transport socket
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>tos</i></TD><TD align="left" valign="top">Type Of Service bits to set
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if operation was successfull, false if an error occured
</p>
<A NAME="rtpSock"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline Socket* <strong>rtpSock</strong> ()
<br></td><td align="right"><h3><strong>rtpSock</strong></h3></td></tr></table><p></p><p>
Get the main transport socket used by this session
</p>
<p><b>Returns</b>: Pointer to the RTP or UDPTL socket, NULL if no transport exists
</p>
<A NAME="drillHole"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>drillHole</strong> ()
<br></td><td align="right"><h3><strong>drillHole</strong></h3></td></tr></table><p></p><p>
Drill a hole in a firewall or NAT for the RTP and RTCP sockets
</p>
<p><b>Returns</b>: True if at least a packet was sent for the RTP socket
</p>
<A NAME="setTimeout"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setTimeout</strong> (int interval)
<br></td><td align="right"><h3><strong>setTimeout</strong></h3></td></tr></table><p></p><p>
Set the interval until receiver timeout is detected
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>interval</i></TD><TD align="left" valign="top">Milliseconds until receiver times out, zero to disable
</TD></TR>
</TABLE></P>
<A NAME="transport"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RTPTransport* <strong>transport</strong> ()
<br></td><td align="right"><h3><strong>transport</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the RTP/RTCP transport of data handled by this session.
</p>
<p><b>Returns</b>: A pointer to the RTPTransport of this session
</p>
<A NAME="transport"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>transport</strong> (RTPTransport* trans)
<br></td><td align="right"><h3><strong>transport</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Set the UDP transport of data handled by this session
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>trans</i></TD><TD align="left" valign="top">A pointer to the new RTPTransport for this session
</TD></TR>
</TABLE></P>
<A NAME="UDPSession"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>UDPSession</strong> ()
<br></td><td align="right"><h3><strong>UDPSession</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Default constructor
</p>
<A NAME="timeout"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>timeout</strong> (bool initial)
<br></td><td align="right"><h3><strong>timeout</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called when the receiver timed out
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>initial</i></TD><TD align="left" valign="top">True if no packet was ever received in this session
</TD></TR>
</TABLE></P>
<A NAME="m_transport"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>RTPTransport* <strong>m_transport</strong>
</td><td align="right"><h3><strong>m_transport</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_timeoutTime"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int64_t">u_int64_t</A> <strong>m_timeoutTime</strong>
</td><td align="right"><h3><strong>m_timeoutTime</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_timeoutInterval"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int64_t">u_int64_t</A> <strong>m_timeoutInterval</strong>
</td><td align="right"><h3><strong>m_timeoutInterval</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>
|
