XMLElementOut Class Reference
An outgoing XML element. More...
#include <xmlparser.h>
Inheritance diagram for XMLElementOut:
Public Member Functions | |
| XMLElementOut (XMLElement *element, const char *senderID=0, bool unclose=false) | |
| virtual | ~XMLElementOut () |
| XMLElement * | element () const |
| bool | sent () const |
| String & | buffer () |
| const String & | id () const |
| u_int32_t | dataCount () |
| const char * | getData (u_int32_t &nCount) |
| void | dataSent (u_int32_t nCount) |
| XMLElement * | release () |
| void | toBuffer (String &buffer) |
| void | prepareToSend () |
Detailed Description
An outgoing XML element.
This class holds an XML element to be sent through a stream
Constructor & Destructor Documentation
| XMLElementOut | ( | XMLElement * | element, | |
| const char * | senderID = 0, |
|||
| bool | unclose = false | |||
| ) | [inline] |
Constructor
- Parameters:
-
element The XML element senderID Optional sender id unclose True to not close the tag when building the buffer
| virtual ~XMLElementOut | ( | ) | [inline, virtual] |
Destructor Delete m_element if not 0
References TelEngine::destruct().
Member Function Documentation
| String& buffer | ( | ) | [inline] |
Get the data buffer
- Returns:
- The data buffer
| u_int32_t dataCount | ( | ) | [inline] |
Get the remainig byte count to send
- Returns:
- The unsent number of bytes
| void dataSent | ( | u_int32_t | nCount | ) | [inline] |
Increase the offset with nCount bytes. Set the sent flag
- Parameters:
-
nCount The number of bytes sent
| XMLElement* element | ( | ) | const [inline] |
Get the underlying element
- Returns:
- The underlying element
| const char* getData | ( | u_int32_t & | nCount | ) | [inline] |
Get the remainig data to send. Set the buffer if not already set
- Parameters:
-
nCount The number of unsent bytes
- Returns:
- Pointer to the remaining data or 0
| const String& id | ( | ) | const [inline] |
Get the id member
- Returns:
- The id member
| void prepareToSend | ( | ) | [inline] |
Fill the buffer with the XML element to send
| XMLElement* release | ( | ) | [inline] |
Release the ownership of m_element The caller is responsable of returned pointer
- Returns:
- XMLElement pointer or 0
| bool sent | ( | ) | const [inline] |
Check if this element was (partially) sent
- Returns:
- True if an attempt to send this element was already done
| void toBuffer | ( | String & | buffer | ) | [inline] |
Fill a buffer with the XML element to send
- Parameters:
-
buffer The buffer to fill
References XMLElement::toString().
The documentation for this class was generated from the following file:
