IAXIEList Class Reference
Information Element container.
More...
#include <yateiax.h>
List of all members.
Public Member Functions |
| IAXIEList () |
| IAXIEList (const IAXFullFrame *frame, bool incoming=true) |
| ~IAXIEList () |
bool | invalidIEList () const |
void | clear () |
void | insertVersion () |
bool | validVersion () |
void | appendIE (IAXInfoElement *ie) |
void | appendNull (IAXInfoElement::Type type) |
void | appendString (IAXInfoElement::Type type, const String &src) |
void | appendString (IAXInfoElement::Type type, unsigned char *src, unsigned len) |
void | appendNumeric (IAXInfoElement::Type type, u_int32_t value, u_int8_t len) |
void | appendBinary (IAXInfoElement::Type type, unsigned char *data, unsigned len) |
bool | createFromFrame (const IAXFullFrame *frame, bool incoming=true) |
void | toBuffer (DataBlock &buf) |
void | toString (String &dest, const char *indent=0) |
IAXInfoElement * | getIE (IAXInfoElement::Type type) |
bool | getString (IAXInfoElement::Type type, String &dest) |
bool | getNumeric (IAXInfoElement::Type type, u_int32_t &dest) |
bool | getBinary (IAXInfoElement::Type type, DataBlock &dest) |
Detailed Description
Information Element container.
Management class for a list of Information Elements
Constructor & Destructor Documentation
Constructor. Construct the list from an IAXFullFrame object
- Parameters:
-
| frame | Source object |
| incoming | True if it is an incoming frame |
Member Function Documentation
Append a binary Information Element to the list
- Parameters:
-
| type | The type of the IAXInfoElementBinary to append |
| data | The source data to append |
| len | Source length |
Append an Information Element to the list
- Parameters:
-
Append an Information Element to the list
- Parameters:
-
Append a numeric Information Element to the list
- Parameters:
-
Append a text Information Element to the list from a buffer
- Parameters:
-
bool createFromFrame |
( |
const IAXFullFrame * |
frame, |
|
|
bool |
incoming = true | |
|
) |
| | |
Construct the list from an IAXFullFrame object. On exit m_invalidIEList will contain the opposite of the returned value
- Parameters:
-
| frame | Source object |
| incoming | True if it is an incoming frame |
- Returns:
- False if the frame contains invalid IEs
Get the data of a list item into a DataBlock. Before any operation dest is cleared
- Parameters:
-
| type | The desired type |
| dest | The destination buffer |
- Returns:
- False if the list doesn't contain an IE of this type
Get the data of a list item into a numeric destination
- Parameters:
-
| type | The desired type |
| dest | The destination |
- Returns:
- False if the list doesn't contain an IE of this type
Get the data of a list item into a String. Before any operation dest is cleared
- Parameters:
-
| type | The desired type |
| dest | The destination String |
- Returns:
- False if the list doesn't contain an IE of this type
Insert a VERSION Information Element in the list if not already done
bool invalidIEList |
( |
|
) |
const [inline] |
Get the invalid IE list flag
- Returns:
- False if the last frame parse was unsuccessful
Construct a buffer from this list
- Parameters:
-
void toString |
( |
String & |
dest, |
|
|
const char * |
indent = 0 | |
|
) |
| | |
Add this list to a string
- Parameters:
-
| dest | Destination string |
| indent | Optional indent for each element |
bool validVersion |
( |
|
) |
[inline] |
Get the validity of the VERSION Information Element of the list if any
- Returns:
- False if version is not IAX_PROTOCOL_VERSION or the list doesn't contain a VERSION Information Element
The documentation for this class was generated from the following file: