IAX2IeUserName Class Reference

`#include <ies.h>`

Inheritance diagram for IAX2IeUserName:

## Public Member Functions

| IAX2IeUserName (BYTE length, BYTE *srcData)
| IAX2IeUserName (const PString &newValue)
virtual void | PrintOn (ostream &str) const
virtual BYTE | GetKeyValue () const
virtual void | StoreDataIn (IAX2IeData &res)
Public Member Functions inherited from IAX2IeString
| IAX2IeString (BYTE length, BYTE *srcData)
| IAX2IeString (const PString &newValue)
| IAX2IeString (const char *newValue)
| IAX2IeString ()
virtual BYTE | GetLengthOfData ()
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 ()
void | SetData (int &)
int | ReadData ()
void | WriteBinary (void *data, PINDEX &writeIndex)

## 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 Public Member Functions inherited from IAX2Ie
static IAX2Ie * | BuildInformationElement (BYTE _typeCode, BYTE length, BYTE *srcData)
Protected Member Functions inherited from IAX2IeString
virtual void | WriteBinary (BYTE *data)
Protected Attributes inherited from IAX2IeString
PString | dataValue
Protected Attributes inherited from IAX2Ie
PBoolean | validData

## Detailed Description

An Information Element that contains the userName (peer or user) for authentication

## Constructor & Destructor Documentation

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

inline

Constructor from data read from the network.

Contents are undefined if the network data is bogus/invalid

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

inline

Initialise to the supplied string value

References IAX2IeString::SetData().

## Member Function Documentation

virtual BYTE IAX2IeUserName::GetKeyValue | ( |  | ) | const

inline virtual

Get the key value for this particular Information Element class

Reimplemented from IAX2Ie.

References IAX2Ie::ie_userName.

virtual void IAX2IeUserName::PrintOn | ( | ostream & | str | ) | const

virtual

print this class (nicely) to the designated stream

Reimplemented from IAX2IeString.

virtual void IAX2IeUserName::StoreDataIn | ( | IAX2IeData & | res | ) |

inline virtual

Take the data from this IAX2Ie, and copy it into the IAX2IeData structure. This is done on processing an incoming frame which contains IAX2Ie in the data section.

Reimplemented from IAX2Ie.

References IAX2IeString::dataValue, and IAX2IeData::userName.

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

- ies.h