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
|
<HTML>
<HEAD>
<TITLE>class UDPTLSession</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 UDPTLSession</h1>
</TD>
<TD valign="top" align="right" colspan="1">UDPTL session. <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>::UDPTLSession</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><A HREF="TelEngine__UDPSession.html">TelEngine::UDPSession</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__UDPTLSession.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="#ref1">~UDPTLSession</A></b> ()
</LI>
<LI>inline bool <b><A HREF="#ref2">localAddr</A></b> (SocketAddr& addr)
</LI>
<LI>inline <A HREF="#u_int16_t">u_int16_t</A> <b><A HREF="#ref3">maxLen</A></b> () const
</LI>
<LI>inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref4">maxSec</A></b> () const
</LI>
<LI>virtual void <b><A HREF="#ref5">rtpData</A></b> (const void* data, int len)
</LI>
<LI>bool <b><A HREF="#ref6">udptlSend</A></b> (const void* data, int len, <A HREF="#u_int16_t">u_int16_t</A> seq)
</LI>
</ul><h4>Protected Methods</h4><ul><LI> <b><A HREF="#ref7">UDPTLSession</A></b> (<A HREF="#u_int16_t">u_int16_t</A> maxLen = 250, <A HREF="#u_int8_t">u_int8_t</A> maxSec = 2)
</LI>
<LI>virtual void <b><A HREF="#ref8">timerTick</A></b> (const Time& when)
</LI>
<LI>virtual RTPTransport* <b><A HREF="#ref9">createTransport</A></b> ()
</LI>
<LI>virtual void <b><i><A HREF="#ref10">udptlRecv</A></i></b> (const void* data, int len, <A HREF="#u_int16_t">u_int16_t</A> seq, bool recovered)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
A bidirectional UDPTL session usable for T.38
</p>
<A NAME="~UDPTLSession"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~UDPTLSession</strong> ()
<br></td><td align="right"><h3><strong>~UDPTLSession</strong></h3></td></tr></table><p></p><p>
Destructor
</p>
<A NAME="localAddr"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>localAddr</strong> (SocketAddr& addr)
<br></td><td align="right"><h3><strong>localAddr</strong></h3></td></tr></table><p></p><p>
Set the local 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 local RTP transport address
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if address set, false if a failure occured
</p>
<A NAME="maxLen"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int16_t">u_int16_t</A> <strong>maxLen</strong> ()
<br></td><td align="right"><h3><strong>maxLen</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the maximum UDPTL packet length
</p>
<p><b>Returns</b>: Maximum length of UDPTL packet length in bytes
</p>
<A NAME="maxSec"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>maxSec</strong> ()
<br></td><td align="right"><h3><strong>maxSec</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the maximum number of UDPTL secondary IFPs
</p>
<p><b>Returns</b>: Maximum number of secondary IFPs, zero if disabled
</p>
<A NAME="rtpData"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>rtpData</strong> (const void* data, int len)
<br></td><td align="right"><h3><strong>rtpData</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
This method is called to send or process an UDPTL packet
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to raw UDPTL data
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the data packet
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__RTPProcessor.html#rtpData">RTPProcessor</A>.</p>
<A NAME="udptlSend"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>udptlSend</strong> (const void* data, int len, <A HREF="#u_int16_t">u_int16_t</A> seq)
<br></td><td align="right"><h3><strong>udptlSend</strong></h3></td></tr></table><p></p><p>
Send UDPTL data over the transport, add older blocks for error recovery
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to IFP block to send as primary
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of primary IFP block
</TD></TR>
<TR><TD align="left" valign="top"><i>seq</i></TD><TD align="left" valign="top">Sequence number to incorporate in message
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if data block was sent, false if an error occured
</p>
<A NAME="UDPTLSession"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>UDPTLSession</strong> (<A HREF="#u_int16_t">u_int16_t</A> maxLen = 250, <A HREF="#u_int8_t">u_int8_t</A> maxSec = 2)
<br></td><td align="right"><h3><strong>UDPTLSession</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
UDPTL Session constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>maxLen</i></TD><TD align="left" valign="top">Maximum length of UDPTL packet, at least longest primary IFP + 5 bytes
</TD></TR>
<TR><TD align="left" valign="top"><i>maxSec</i></TD><TD align="left" valign="top">Maximum number of secondary IFPs, set to zero to disable
</TD></TR>
</TABLE></P>
<A NAME="timerTick"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>timerTick</strong> (const Time& when)
<br></td><td align="right"><h3><strong>timerTick</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called periodically to push any asynchronous data or statistics
</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>
<p>Reimplemented from <A HREF="TelEngine__RTPProcessor.html#timerTick">RTPProcessor</A>.</p>
<A NAME="createTransport"></A><A NAME="ref9"></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>[protected virtual]</small></p><p>
Create a new UDPTL 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>
<p>Reimplemented from <A HREF="TelEngine__UDPSession.html#createTransport">UDPSession</A>.</p>
<A NAME="udptlRecv"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <i><strong>udptlRecv</strong></i> (const void* data, int len, <A HREF="#u_int16_t">u_int16_t</A> seq, bool recovered)
<br></td><td align="right"><h3><i><strong>udptlRecv</strong></i></h3></td></tr></table><p> <small>[protected pure virtual]</small></p><p>
Method called when UDPTL data is received
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to IFP block
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the IFP block
</TD></TR>
<TR><TD align="left" valign="top"><i>seq</i></TD><TD align="left" valign="top">Sequence number of the block
</TD></TR>
<TR><TD align="left" valign="top"><i>recovered</i></TD><TD align="left" valign="top">True if the IFP block was recovered after data loss
</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>
|
