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
|
<HTML>
<HEAD>
<TITLE>class IAXFrameOut</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 IAXFrameOut</h1>
</TD>
<TD valign="top" align="right" colspan="1">This class holds an outgoing 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>::IAXFrameOut</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__IAXFullFrame.html">TelEngine::IAXFullFrame</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__IAXFrameOut.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="#ref1">IAXFrameOut</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, unsigned int len,
<A HREF="#u_int16_t">u_int16_t</A> retransCount, <A HREF="#u_int32_t">u_int32_t</A> retransInterval, bool ackOnly)
</LI>
<LI>virtual <b><A HREF="#ref2">~IAXFrameOut</A></b> ()
</LI>
<LI>inline bool <b><A HREF="#ref3">timeout</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref4">timeForRetrans</A></b> (<A HREF="#u_int64_t">u_int64_t</A> time) const
</LI>
<LI>void <b><A HREF="#ref5">setRetrans</A></b> ()
</LI>
<LI>void <b><A HREF="#ref6">transmitted</A></b> ()
</LI>
<LI>inline bool <b><A HREF="#ref7">ack</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref8">setAck</A></b> ()
</LI>
<LI>inline bool <b><A HREF="#ref9">ackOnly</A></b> () const
</LI>
<LI>void <b><A HREF="#ref10">adjustAuthTimeout</A></b> (<A HREF="#u_int64_t">u_int64_t</A> nextTransTime)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class holds all data needded to manage an outgoing IAX full frame
</p>
<A NAME="IAXFrameOut"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>IAXFrameOut</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, unsigned int len,
<A HREF="#u_int16_t">u_int16_t</A> retransCount, <A HREF="#u_int32_t">u_int32_t</A> retransInterval, bool ackOnly)
<br></td><td align="right"><h3><strong>IAXFrameOut</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>
<TR><TD align="left" valign="top"><i>retransCount</i></TD><TD align="left" valign="top">Retransmission counter
</TD></TR>
<TR><TD align="left" valign="top"><i>retransInterval</i></TD><TD align="left" valign="top">Time interval to the next retransmission
</TD></TR>
<TR><TD align="left" valign="top"><i>ackOnly</i></TD><TD align="left" valign="top">Acknoledge only flag. If true, the frame only expects an ACK
</TD></TR>
</TABLE></P>
<A NAME="~IAXFrameOut"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~IAXFrameOut</strong> ()
<br></td><td align="right"><h3><strong>~IAXFrameOut</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="timeout"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>timeout</strong> ()
<br></td><td align="right"><h3><strong>timeout</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the timeout (retransmission counter) of this frame
</p>
<p><b>Returns</b>: True if the retransmission counter is 0
</p>
<A NAME="timeForRetrans"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>timeForRetrans</strong> (<A HREF="#u_int64_t">u_int64_t</A> time)
<br></td><td align="right"><h3><strong>timeForRetrans</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Ask the frame if it's time for retransmit
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>time</i></TD><TD align="left" valign="top">Current time
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if it's time to retransmit
</p>
<A NAME="setRetrans"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setRetrans</strong> ()
<br></td><td align="right"><h3><strong>setRetrans</strong></h3></td></tr></table><p></p><p>
Set the retransmission flag of this frame
</p>
<A NAME="transmitted"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>transmitted</strong> ()
<br></td><td align="right"><h3><strong>transmitted</strong></h3></td></tr></table><p></p><p>
Update the retransmission counter and the time to next retransmission
</p>
<A NAME="ack"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>ack</strong> ()
<br></td><td align="right"><h3><strong>ack</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the acknoledged flag of this frame
</p>
<p><b>Returns</b>: The acknoledged flag of this frame
</p>
<A NAME="setAck"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>setAck</strong> ()
<br></td><td align="right"><h3><strong>setAck</strong></h3></td></tr></table><p></p><p>
Set the acknoledged flag of this frame
</p>
<A NAME="ackOnly"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>ackOnly</strong> ()
<br></td><td align="right"><h3><strong>ackOnly</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the acknoledge only flag of this frame
</p>
<p><b>Returns</b>: The acknoledge only flag of this frame
</p>
<A NAME="adjustAuthTimeout"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>adjustAuthTimeout</strong> (<A HREF="#u_int64_t">u_int64_t</A> nextTransTime)
<br></td><td align="right"><h3><strong>adjustAuthTimeout</strong></h3></td></tr></table><p></p><p>
Increase the timeout for acknoledged authentication frames sent and set the counter to 1
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>nextTransTime</i></TD><TD align="left" valign="top">Next transmission time
</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>
|
