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
|
<HTML>
<HEAD>
<TITLE>class IAXMetaTrunkFrame</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 IAXMetaTrunkFrame</h1>
</TD>
<TD valign="top" align="right" colspan="1">Meta trunk 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>::IAXMetaTrunkFrame</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>Inherits</TH><TD><A HREF="TelEngine__Mutex.html">TelEngine::Mutex</A> <small>[public ]</small>, <A HREF="TelEngine__RefObject.html">TelEngine::RefObject</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__IAXMetaTrunkFrame.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">IAXMetaTrunkFrame</A></b> (IAXEngine* engine, const SocketAddr& addr)
</LI>
<LI>virtual <b><A HREF="#ref2">~IAXMetaTrunkFrame</A></b> ()
</LI>
<LI>inline const SocketAddr& <b><A HREF="#ref3">addr</A></b> () const
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> <b><A HREF="#ref4">timestamp</A></b> ()
</LI>
<LI>void <b><A HREF="#ref5">setTimestamp</A></b> (<A HREF="#u_int32_t">u_int32_t</A> tStamp)
</LI>
<LI>bool <b><A HREF="#ref6">add</A></b> (<A HREF="#u_int16_t">u_int16_t</A> sCallNo, const DataBlock& data, <A HREF="#u_int32_t">u_int32_t</A> tStamp)
</LI>
<LI>bool <b><A HREF="#ref7">send</A></b> (<A HREF="#u_int32_t">u_int32_t</A> tStamp)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Handle meta trunk frame with timestamps
</p>
<A NAME="IAXMetaTrunkFrame"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>IAXMetaTrunkFrame</strong> (IAXEngine* engine, const SocketAddr& addr)
<br></td><td align="right"><h3><strong>IAXMetaTrunkFrame</strong></h3></td></tr></table><p></p><p>
Constructor. Constructs an outgoing meta trunk frame
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>engine</i></TD><TD align="left" valign="top">The engine that owns this frame
</TD></TR>
<TR><TD align="left" valign="top"><i>addr</i></TD><TD align="left" valign="top">Remote peer address
</TD></TR>
</TABLE></P>
<A NAME="~IAXMetaTrunkFrame"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~IAXMetaTrunkFrame</strong> ()
<br></td><td align="right"><h3><strong>~IAXMetaTrunkFrame</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="addr"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const SocketAddr& <strong>addr</strong> ()
<br></td><td align="right"><h3><strong>addr</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the remote peer address
</p>
<p><b>Returns</b>: The remote peer address
</p>
<A NAME="timestamp"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> <strong>timestamp</strong> ()
<br></td><td align="right"><h3><strong>timestamp</strong></h3></td></tr></table><p></p><p>
Get the timestamp of this frame
</p>
<p><b>Returns</b>: The timestamp of this frame
</p>
<A NAME="setTimestamp"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setTimestamp</strong> (<A HREF="#u_int32_t">u_int32_t</A> tStamp)
<br></td><td align="right"><h3><strong>setTimestamp</strong></h3></td></tr></table><p></p><p>
Set the timestamp of this frame
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>tStamp</i></TD><TD align="left" valign="top">Timestamp value to set
</TD></TR>
</TABLE></P>
<A NAME="add"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>add</strong> (<A HREF="#u_int16_t">u_int16_t</A> sCallNo, const DataBlock& data, <A HREF="#u_int32_t">u_int32_t</A> tStamp)
<br></td><td align="right"><h3><strong>add</strong></h3></td></tr></table><p></p><p>
Add a mini frame. If no room, send before adding
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>sCallNo</i></TD><TD align="left" valign="top">Sorce call number
</TD></TR>
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Mini frame data
</TD></TR>
<TR><TD align="left" valign="top"><i>tStamp</i></TD><TD align="left" valign="top">Mini frame timestamp
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: False if the frame was sent and the write operation failed
</p>
<A NAME="send"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>send</strong> (<A HREF="#u_int32_t">u_int32_t</A> tStamp)
<br></td><td align="right"><h3><strong>send</strong></h3></td></tr></table><p></p><p>
Send this frame to remote peer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>tStamp</i></TD><TD align="left" valign="top">Frame timestamp
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The result of the write operation
</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>
|
