OPAL  Version 3.10.10
IAX2IeString Class Reference

#include <ies.h>

Inheritance diagram for IAX2IeString:
IAX2Ie IAX2IeCalledContext IAX2IeCalledNumber IAX2IeCallingAni IAX2IeCallingName IAX2IeCallingNumber IAX2IeCause IAX2IeChallenge IAX2IeDeviceType IAX2IeDnid IAX2IeEncKey IAX2IeLanguage IAX2IeMd5Result IAX2IePassword IAX2IeRdnis IAX2IeRsaResult IAX2IeServiceIdent IAX2IeUserName

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 &)
 
int ReadData ()
 
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 Public Member Functions inherited from IAX2Ie
static IAX2IeBuildInformationElement (BYTE _typeCode, BYTE length, BYTE *srcData)
 

Detailed Description

An Information Element that contains an array of characters.

Constructor & Destructor Documentation

◆ IAX2IeString() [1/4]

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

Constructor - read data from source array.

Contents are valid if source array is valid.

◆ IAX2IeString() [2/4]

IAX2IeString::IAX2IeString ( const PString &  newValue)
inline

Construct to an initialised value

References IAX2Ie::SetData().

◆ IAX2IeString() [3/4]

IAX2IeString::IAX2IeString ( const char *  newValue)
inline

Construct to an initialised value

References IAX2Ie::SetData().

◆ IAX2IeString() [4/4]

IAX2IeString::IAX2IeString ( )
inline

Constructor to an invalid and empty result

References IAX2Ie::GetLengthOfData(), IAX2Ie::PrintOn(), and IAX2Ie::SetData().

Member Function Documentation

◆ GetLengthOfData()

virtual BYTE IAX2IeString::GetLengthOfData ( )
virtual

return the number of bytes to hold this data element

Reimplemented from IAX2Ie.

◆ PrintOn()

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

◆ ReadData()

PString IAX2IeString::ReadData ( )
inline

Report the value of the stored data for this class

References IAX2Ie::WriteBinary().

◆ SetData() [1/2]

void IAX2IeString::SetData ( const PString &  newData)

Take the supplied data and copy contents into this IE

◆ SetData() [2/2]

void IAX2IeString::SetData ( const char *  newData)

Take the supplied data and copy contents into this IE

◆ WriteBinary()

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

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

Reimplemented from IAX2Ie.

Field Documentation

◆ dataValue

PString IAX2IeString::dataValue
protected

The actual data stored in a IAX2IeString class


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