OPAL Version 3.10.4

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Protected Member Functions | Protected Attributes
IAX2IeString Class Reference

`#include <ies.h>`

Inheritance diagram for IAX2IeString:

## Public Member Functions

construction/destruction
| IAX2IeString (BYTE length, BYTE *srcData)
| IAX2IeString (const PString &newValue)
| IAX2IeString (const char *newValue)
| IAX2IeString ()
Worker methods
virtual BYTE | GetLengthOfData ()
void | PrintOn (ostream &str) const
void | SetData (const PString &newData)
void | SetData (const char *newData)
PString | ReadData ()
Public Member Functions inherited from IAX2Ie
| IAX2Ie ()
virtual | ~IAX2Ie ()
virtual PBoolean | IsValid ()
int | GetBinarySize ()
virtual BYTE | GetKeyValue () const
void | SetData (int &)
void | WriteBinary (void *data, PINDEX &writeIndex)
virtual void | StoreDataIn (IAX2IeData &)

## Protected Member Functions

virtual void | WriteBinary (BYTE *data)

## Protected Attributes

PString | dataValue
Protected Attributes inherited from IAX2Ie
PBoolean | validData

## Additional Inherited Members

Public Types inherited from IAX2Ie

enum

IAX2IeTypeCode {
ie_calledNumber = 1, ie_callingNumber = 2, ie_callingAni = 3, ie_callingName = 4,
ie_calledContext = 5, ie_userName = 6, ie_password = 7, ie_capability = 8,
ie_format = 9, ie_language = 10, ie_version = 11, ie_adsicpe = 12,
ie_dnid = 13, ie_authMethods = 14, ie_challenge = 15, ie_md5Result = 16,
ie_rsaResult = 17, ie_apparentAddr = 18, ie_refresh = 19, ie_dpStatus = 20,
ie_callNo = 21, ie_cause = 22, ie_iaxUnknown = 23, ie_msgCount = 24,
ie_autoAnswer = 25, ie_musicOnHold = 26, ie_transferId = 27, ie_rdnis = 28,
ie_provisioning = 29, ie_aesProvisioning = 30, ie_dateTime = 31, ie_deviceType = 32,
ie_serviceIdent = 33, ie_firmwareVer = 34, ie_fwBlockDesc = 35, ie_fwBlockData = 36,
ie_provVer = 37, ie_callingPres = 38, ie_callingTon = 39, ie_callingTns = 40,
ie_samplingRate = 41, ie_causeCode = 42, ie_encryption = 43, ie_encKey = 44,
ie_codecPrefs = 45, ie_recJitter = 46, ie_recLoss = 47, ie_recPackets = 48,
ie_recDelay = 49, ie_recDropped = 50, ie_recOoo = 51, ie_variable = 52,
ie_ospToken = 53, ie_callToken = 54, ie_capability2 = 55, ie_format2 = 56,
ie_countEntries
}

static IAX2Ie * | BuildInformationElement (BYTE _typeCode, BYTE length, BYTE *srcData)

## Detailed Description

An Information Element that contains an array of characters.

## Constructor & Destructor Documentation

IAX2IeString::IAX2IeString | ( | BYTE | length,
|  | BYTE * | srcData
| ) |  |

Constructor - read data from source array.

Contents are valid if source array is valid.

IAX2IeString::IAX2IeString | ( | const PString & | newValue | ) |

inline

Construct to an initialised value

References SetData().

IAX2IeString::IAX2IeString | ( | const char * | newValue | ) |

inline

Construct to an initialised value

References SetData().

IAX2IeString::IAX2IeString | ( |  | ) |

inline

Constructor to an invalid and empty result

## Member Function Documentation

virtual BYTE IAX2IeString::GetLengthOfData | ( |  | ) |

virtual

return the number of bytes to hold this data element

Reimplemented from IAX2Ie.

void IAX2IeString::PrintOn | ( | ostream & | str | ) | const

virtual

print this class (nicely) to the designated stream

Reimplemented from IAX2Ie.

Reimplemented in IAX2IeEncKey, IAX2IeServiceIdent, IAX2IeDeviceType, IAX2IeRdnis, IAX2IeCause, IAX2IeRsaResult, IAX2IeMd5Result, IAX2IeChallenge, IAX2IeDnid, IAX2IeLanguage, IAX2IePassword, IAX2IeUserName, IAX2IeCalledContext, IAX2IeCallingName, IAX2IeCallingAni, IAX2IeCallingNumber, and IAX2IeCalledNumber.

PString IAX2IeString::ReadData | ( |  | ) |

inline

Report the value of the stored data for this class

Reimplemented from IAX2Ie.

References dataValue.

void IAX2IeString::SetData | ( | const PString & | newData | ) |

Take the supplied data and copy contents into this IE

Referenced by IAX2IeCalledContext::IAX2IeCalledContext(), IAX2IeCalledNumber::IAX2IeCalledNumber(), IAX2IeCallingAni::IAX2IeCallingAni(), IAX2IeCallingName::IAX2IeCallingName(), IAX2IeCallingNumber::IAX2IeCallingNumber(), IAX2IeChallenge::IAX2IeChallenge(), IAX2IeDnid::IAX2IeDnid(), IAX2IeLanguage::IAX2IeLanguage(), IAX2IeMd5Result::IAX2IeMd5Result(), IAX2IePassword::IAX2IePassword(), IAX2IeRsaResult::IAX2IeRsaResult(), IAX2IeString(), and IAX2IeUserName::IAX2IeUserName().

void IAX2IeString::SetData | ( | const char * | newData | ) |

Take the supplied data and copy contents into this IE

virtual void IAX2IeString::WriteBinary | ( | BYTE * | data | ) |

protected virtual

Take the data value for this particular IAX2Ie and copy into the memory region.

Reimplemented from IAX2Ie.

## Field Documentation

PString IAX2IeString::dataValue

protected

The actual data stored in a IAX2IeString class

Referenced by ReadData(), IAX2IeCalledNumber::StoreDataIn(), IAX2IeCallingNumber::StoreDataIn(), IAX2IeCallingAni::StoreDataIn(), IAX2IeCallingName::StoreDataIn(), IAX2IeCalledContext::StoreDataIn(), IAX2IeUserName::StoreDataIn(), IAX2IePassword::StoreDataIn(), IAX2IeLanguage::StoreDataIn(), IAX2IeDnid::StoreDataIn(), IAX2IeChallenge::StoreDataIn(), IAX2IeMd5Result::StoreDataIn(), IAX2IeRsaResult::StoreDataIn(), IAX2IeCause::StoreDataIn(), IAX2IeRdnis::StoreDataIn(), IAX2IeDeviceType::StoreDataIn(), IAX2IeServiceIdent::StoreDataIn(), and IAX2IeEncKey::StoreDataIn().

The documentation for this class was generated from the following file:

- ies.h