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
|
<HTML>
<HEAD>
<TITLE>class DataNode</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 DataNode</h1>
</TD>
<TD valign="top" align="right" colspan="1">
A generic data handling object
<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>::DataNode</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="yatephone_h.html">yatephone.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__RefObject.html">TelEngine::RefObject</A> <small>[public ]</small></TD></TR>
<TR><TH>Inherited by</TH><TD><i><A HREF="TelEngine__DataConsumer.html">DataConsumer</A></i>, <A HREF="TelEngine__DataSource.html">DataSource</A>, <A HREF="TelEngine__DataTranslator.html">DataTranslator</A>, <i><A HREF="TelEngine__ThreadedSource.html">ThreadedSource</A></i></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__DataNode.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 Types</h4><ul><LI>enum <A HREF="#ref2">DataFlags</A> { DataStart = 0x0001,
DataEnd = 0x0002,
DataMark = 0x0004,
DataSilent = 0x0008,
DataMissed = 0x0010,
DataError = 0x0020,
DataPrivate = 0x0100
}
</LI>
</ul><h4>Public Methods</h4><ul><LI>inline <b><A HREF="#ref3">DataNode</A></b> (const char* format = 0)
</LI>
<LI>virtual int <b><A HREF="#ref4">costFormat</A></b> (const DataFormat& format)
</LI>
<LI>virtual bool <b><A HREF="#ref5">setFormat</A></b> (const DataFormat& format)
</LI>
<LI>inline const DataFormat& <b><A HREF="#ref6">getFormat</A></b> () const
</LI>
<LI>inline unsigned long <b><A HREF="#ref7">timeStamp</A></b> () const
</LI>
<LI>virtual bool <b><A HREF="#ref8">valid</A></b> () const
</LI>
<LI>virtual bool <b><A HREF="#ref9">control</A></b> (NamedList& params)
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static inline unsigned long <b><A HREF="#ref10">invalidStamp</A></b> ()
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref11">attached</A></b> (bool added)
</LI>
</ul><h4>Protected Members</h4><ul><LI>DataFormat <b><A HREF="#ref12">m_format</A></b></LI>
<LI>unsigned long <b><A HREF="#ref13">m_timestamp</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
A generic data handling object
</p>
<A NAME="DataFlags"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>DataFlags</strong> { DataStart = 0x0001,
DataEnd = 0x0002,
DataMark = 0x0004,
DataSilent = 0x0008,
DataMissed = 0x0010,
DataError = 0x0020,
DataPrivate = 0x0100
}
</td><td align="right"><h3><strong>DataFlags</strong></h3></td></tr></table><p></p><p>
Flags associated with the DataBlocks forwarded between nodes
</p>
<A NAME="DataNode"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>DataNode</strong> (const char* format = 0)
<br></td><td align="right"><h3><strong>DataNode</strong></h3></td></tr></table><p></p><p>
Construct a DataNode
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>format</i></TD><TD align="left" valign="top">Description of the data format, default none
</TD></TR>
</TABLE></P>
<A NAME="costFormat"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> int <strong>costFormat</strong> (const DataFormat& format)
<br></td><td align="right"><h3><strong>costFormat</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Get the computing cost of converting the data to the format asked
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>format</i></TD><TD align="left" valign="top">Name of the format to check for
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: -1 if unsupported, 0 for native format else cost in KIPS
</p>
<A NAME="setFormat"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>setFormat</strong> (const DataFormat& format)
<br></td><td align="right"><h3><strong>setFormat</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Change the format used to transfer data
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>format</i></TD><TD align="left" valign="top">Name of the format to set for data
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the format changed successfully, false if not changed
</p>
<A NAME="getFormat"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const DataFormat& <strong>getFormat</strong> ()
<br></td><td align="right"><h3><strong>getFormat</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the description of the format currently in use
</p>
<p><b>Returns</b>: Pointer to the data format
</p>
<A NAME="timeStamp"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned long <strong>timeStamp</strong> ()
<br></td><td align="right"><h3><strong>timeStamp</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the current position in the data stream
</p>
<p><b>Returns</b>: Timestamp of current data position
</p>
<A NAME="valid"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>valid</strong> ()
<br></td><td align="right"><h3><strong>valid</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Check if this data node is still valid
</p>
<p><b>Returns</b>: True if still valid, false if node should be removed
</p>
<A NAME="control"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>control</strong> (NamedList& params)
<br></td><td align="right"><h3><strong>control</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Modify node parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">The list of parameters to change
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if processed
</p>
<A NAME="invalidStamp"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned long <strong>invalidStamp</strong> ()
<br></td><td align="right"><h3><strong>invalidStamp</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the internal representation of an invalid or unknown timestamp
</p>
<p><b>Returns</b>: Invalid timestamp - unsigned long conversion of -1
</p>
<A NAME="attached"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>attached</strong> (bool added)
<br></td><td align="right"><h3><strong>attached</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Owner attach and detach notification.
This method is called with DataEndpoint::commonMutex() held
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>added</i></TD><TD align="left" valign="top">True if a new owner was added, false if it was removed
</TD></TR>
</TABLE></P>
<A NAME="m_format"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>DataFormat <strong>m_format</strong>
</td><td align="right"><h3><strong>m_format</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_timestamp"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned long <strong>m_timestamp</strong>
</td><td align="right"><h3><strong>m_timestamp</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>
|
