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
|
<HTML>
<HEAD>
<TITLE>class XMLElementOut</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 XMLElementOut</h1>
</TD>
<TD valign="top" align="right" colspan="1">An outgoing XML element. <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>::XMLElementOut</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___yjingle___xmlparser_h.html">libs/yjingle/xmlparser.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><A HREF="full-list-TelEngine__XMLElementOut.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">XMLElementOut</A></b> (XMLElement* element, const char* senderID = 0,
bool unclose = false)
</LI>
<LI>virtual <b><A HREF="#ref2">~XMLElementOut</A></b> ()
</LI>
<LI>inline XMLElement* <b><A HREF="#ref3">element</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref4">sent</A></b> () const
</LI>
<LI>inline String& <b><A HREF="#ref5">buffer</A></b> ()
</LI>
<LI>inline const String& <b><A HREF="#ref6">id</A></b> () const
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> <b><A HREF="#ref7">dataCount</A></b> ()
</LI>
<LI>inline const char* <b><A HREF="#ref8">getData</A></b> (<A HREF="#u_int32_t">u_int32_t</A>& nCount)
</LI>
<LI>inline void <b><A HREF="#ref9">dataSent</A></b> (<A HREF="#u_int32_t">u_int32_t</A> nCount)
</LI>
<LI>inline XMLElement* <b><A HREF="#ref10">release</A></b> ()
</LI>
<LI>inline void <b><A HREF="#ref11">toBuffer</A></b> (String& buffer)
</LI>
<LI>inline void <b><A HREF="#ref12">prepareToSend</A></b> ()
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class holds an XML element to be sent through a stream
</p>
<A NAME="XMLElementOut"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>XMLElementOut</strong> (XMLElement* element, const char* senderID = 0,
bool unclose = false)
<br></td><td align="right"><h3><strong>XMLElementOut</strong></h3></td></tr></table><p></p><p>
Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>element</i></TD><TD align="left" valign="top">The XML element
</TD></TR>
<TR><TD align="left" valign="top"><i>senderID</i></TD><TD align="left" valign="top">Optional sender id
</TD></TR>
<TR><TD align="left" valign="top"><i>unclose</i></TD><TD align="left" valign="top">True to not close the tag when building the buffer
</TD></TR>
</TABLE></P>
<A NAME="~XMLElementOut"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~XMLElementOut</strong> ()
<br></td><td align="right"><h3><strong>~XMLElementOut</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
Delete m_element if not 0
</p>
<A NAME="element"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline XMLElement* <strong>element</strong> ()
<br></td><td align="right"><h3><strong>element</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the underlying element
</p>
<p><b>Returns</b>: The underlying element
</p>
<A NAME="sent"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>sent</strong> ()
<br></td><td align="right"><h3><strong>sent</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this element was (partially) sent
</p>
<p><b>Returns</b>: True if an attempt to send this element was already done
</p>
<A NAME="buffer"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline String& <strong>buffer</strong> ()
<br></td><td align="right"><h3><strong>buffer</strong></h3></td></tr></table><p></p><p>
Get the data buffer
</p>
<p><b>Returns</b>: The data buffer
</p>
<A NAME="id"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>id</strong> ()
<br></td><td align="right"><h3><strong>id</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the id member
</p>
<p><b>Returns</b>: The id member
</p>
<A NAME="dataCount"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> <strong>dataCount</strong> ()
<br></td><td align="right"><h3><strong>dataCount</strong></h3></td></tr></table><p></p><p>
Get the remainig byte count to send
</p>
<p><b>Returns</b>: The unsent number of bytes
</p>
<A NAME="getData"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const char* <strong>getData</strong> (<A HREF="#u_int32_t">u_int32_t</A>& nCount)
<br></td><td align="right"><h3><strong>getData</strong></h3></td></tr></table><p></p><p>
Get the remainig data to send. Set the buffer if not already set
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>nCount</i></TD><TD align="left" valign="top">The number of unsent bytes
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the remaining data or 0
</p>
<A NAME="dataSent"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>dataSent</strong> (<A HREF="#u_int32_t">u_int32_t</A> nCount)
<br></td><td align="right"><h3><strong>dataSent</strong></h3></td></tr></table><p></p><p>
Increase the offset with nCount bytes. Set the sent flag
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>nCount</i></TD><TD align="left" valign="top">The number of bytes sent
</TD></TR>
</TABLE></P>
<A NAME="release"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline XMLElement* <strong>release</strong> ()
<br></td><td align="right"><h3><strong>release</strong></h3></td></tr></table><p></p><p>
Release the ownership of m_element
The caller is responsable of returned pointer
</p>
<p><b>Returns</b>: XMLElement pointer or 0
</p>
<A NAME="toBuffer"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>toBuffer</strong> (String& buffer)
<br></td><td align="right"><h3><strong>toBuffer</strong></h3></td></tr></table><p></p><p>
Fill a buffer with the XML element to send
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>buffer</i></TD><TD align="left" valign="top">The buffer to fill
</TD></TR>
</TABLE></P>
<A NAME="prepareToSend"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>prepareToSend</strong> ()
<br></td><td align="right"><h3><strong>prepareToSend</strong></h3></td></tr></table><p></p><p>
Fill the buffer with the XML element to send
</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>
|
