PSTUNMessage Class Reference

#include <pstun.h>

Inheritance diagram for PSTUNMessage:

Collaboration diagram for PSTUNMessage:

Public Types
enum	MsgType {   InvalidMessage, BindingRequestRFC3489 = 0x10001, BindingRequest = 0x0001, BindingResponse = 0x0101,   BindingError = 0x0111, SharedSecretRequest = 0x0002, SharedSecretResponse = 0x0102, SharedSecretError = 0x0112,   Allocate = 0x0003, AllocateResponse = 0x0103, AllocateError = 0x0113, Refresh = 0x0004,   RefreshResponse = 0x0104, RefreshError = 0x0114, Send = 0x0016, Data = 0x0017,   CreatePermission = 0x0008, CreatePermResponse = 0x0108, CreatePermError = 0x0118, ChannelBind = 0x0009,   ChannelBindResponse = 0x0109, ChannelBindError = 0x0119, Connect = 0x000a, ConnectResponse = 0x010a,   ConnectError = 0x011a, ConnectionBind = 0x000b, ConnectionBindResponse = 0x010b, ConnectionBindError = 0x011b,   ConnectionAttempt = 0x001c }
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the Compare() function. More...

Public Member Functions
	PSTUNMessage ()
	PSTUNMessage (MsgType newType, const BYTE *id=NULL)
	PSTUNMessage (const BYTE *data, PINDEX size, const PIPSocketAddressAndPort &srcAddr)
bool	IsValid () const
bool	IsValidFor (const PSTUNMessage &request) const
PBYTEArray	GetTransactionID () const
bool	IsRFC5389 () const
const PSTUNMessageHeader *	operator-> () const
MsgType	GetType () const
void	SetType (MsgType newType, const BYTE *id=NULL)
void	SetErrorType (int code, const BYTE *id, const char *reason=NULL)
bool	IsRequest () const
bool	IsIndication () const
bool	IsSuccessResponse () const
bool	IsErrorResponse () const
PSTUNAttribute *	AddAttribute (const PSTUNAttribute &attribute)
PSTUNAttribute *	SetAttribute (const PSTUNAttribute &attribute)
PSTUNAttribute *	FindAttribute (PSTUNAttribute::Types type) const
template<class Type >
Type *	FindAttributeAs (PSTUNAttribute::Types type) const
PString	FindAttributeString (PSTUNAttribute::Types type, const char *dflt=NULL) const
bool	Read (PUDPSocket &socket)
bool	Write (PUDPSocket &socket) const
bool	Write (PUDPSocket &socket, const PIPSocketAddressAndPort &ap) const
bool	Poll (PUDPSocket &socket, const PSTUNMessage &request, PINDEX pollRetries)
const PIPSocketAddressAndPort	GetSourceAddressAndPort () const
void	AddFingerprint (PSTUNFingerprint *fp=NULL)
bool	CheckFingerprint (bool required) const
Public Member Functions inherited from PBYTEArray
template<typename T >
const T &	GetAs (PINDEX offset=0)
	Function to cast block of memory in PBYTEArray to another structure. More...
	PBYTEArray (PINDEX initialSize=0)
	Construct a new dynamic array of unsigned chars. More...
	PBYTEArray (BYTE const *buffer, PINDEX length, PBoolean dynamic=true)
	Construct a new dynamic array of unsigned chars. More...
	PBYTEArray (PContainerReference &reference_)
virtual void	PrintOn (ostream &strm) const
	Print the array. More...
virtual void	ReadFrom (istream &strm)
	Read the array. More...
virtual PObject *	Clone () const
	Clone the object. More...
Public Member Functions inherited from PBaseArray< BYTE >
	PBaseArray (PINDEX initialSize=0)
	Construct a new dynamic array of elements of the specified type. More...
	PBaseArray (BYTEconst *buffer, PINDEX length, PBoolean dynamic=true)
	Construct a new dynamic array of elements of the specified type. More...
PBoolean	SetAt (PINDEX index, BYTEval)
	Set the specific element in the array. More...
BYTE	GetAt (PINDEX index) const
	Get a value from the array. More...
void	Attach (const BYTE *buffer, PINDEX bufferSize)
	Attach a pointer to a static block to the base array type. More...
BYTE *	GetPointer (PINDEX minSize=0)
	Get a pointer to the internal array and assure that it is of at least the specified size. More...
BYTE	operator[] (PINDEX index) const
	Get a value from the array. More...
BYTE &	operator[] (PINDEX index)
	Get a reference to value from the array. More...
	operator BYTEconst * () const
	Get a pointer to the internal array. More...
PBoolean	Concatenate (const PBaseArray &array)
	Concatenate one array to the end of this array. More...
Public Member Functions inherited from PAbstractArray
	PAbstractArray (PINDEX elementSizeInBytes, PINDEX initialSize=0)
	Create a new dynamic array of initalSize elements of elementSizeInBytes bytes each. More...
	PAbstractArray (PINDEX elementSizeInBytes, const void *buffer, PINDEX bufferSizeInElements, PBoolean dynamicAllocation)
	Create a new dynamic array of bufferSizeInElements elements of elementSizeInBytes bytes each. More...
virtual Comparison	Compare (const PObject &obj) const
	Get the relative rank of the two arrays. More...
virtual PBoolean	SetSize (PINDEX newSize)
	Set the size of the array in elements. More...
void	Attach (const void *buffer, PINDEX bufferSize)
	Attach a pointer to a static block to the base array type. More...
void *	GetPointer (PINDEX minSize=1)
	Get a pointer to the internal array and assure that it is of at least the specified size. More...
const void *	GetPointer () const
virtual PINDEX	GetLength () const
	Retrun the length in bytes for the array. More...
PBoolean	Concatenate (const PAbstractArray &array)
	Concatenate one array to the end of this array. More...
Public Member Functions inherited from PContainer
	PContainer (PINDEX initialSize=0)
	Create a new unique container. More...
	PContainer (const PContainer &cont)
	Create a new refernce to container. More...
PContainer &	operator= (const PContainer &cont)
	Assign one container reference to another. More...
virtual	~PContainer ()
	Destroy the container class. More...
virtual PINDEX	GetSize () const
	Get the current size of the container. More...
__inline size_t	size () const
PBoolean	SetMinSize (PINDEX minSize)
	Set the minimum size of container. More...
virtual PBoolean	IsEmpty () const
	Determine if the container is empty. More...
__inline bool	empty () const
PBoolean	IsUnique () const
	Determine if container is unique reference. More...
virtual PBoolean	MakeUnique ()
	Make this instance to be the one and only reference to the container contents. More...
Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
__inline void	SetTraceContextIdentifier (unsigned id)
__inline void	SetTraceContextIdentifier (const PObject &obj)
__inline void	SetTraceContextIdentifier (const PObject *obj)
__inline void	CopyTraceContextIdentifier (PObject &obj) const
__inline void	CopyTraceContextIdentifier (PObject *obj) const
virtual	~PObject ()
__inline const char *	GetClass () const
__inline bool	IsClass (const char *name) const
__inline const PObject *	PTraceObjectInstance () const
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

Protected Member Functions
PSTUNAttribute *	GetFirstAttribute () const
DWORD	CalculateFingerprint (PSTUNFingerprint *fp) const
Protected Member Functions inherited from PBaseArray< BYTE >
	PBaseArray (PContainerReference &reference_)
virtual void	PrintElementOn (ostream &stream, PINDEX index) const
Protected Member Functions inherited from PAbstractArray
PBoolean	InternalSetSize (PINDEX newSize, PBoolean force)
virtual void	PrintElementOn (ostream &stream, PINDEX index) const
virtual void	ReadElementFrom (istream &stream, PINDEX index)
	PAbstractArray (PContainerReference &reference, PINDEX elementSizeInBytes)
Protected Member Functions inherited from PContainer
	PContainer (int dummy, const PContainer *cont)
	Constructor used in support of the Clone() function. More...
	PContainer (PContainerReference &reference)
	Construct using static PContainerReference. More...
virtual void	DestroyContents ()=0
	Destroy the container contents. More...
virtual void	AssignContents (const PContainer &c)
	Copy the container contents. More...
void	CopyContents (const PContainer &c)
	Copy the container contents. More...
void	CloneContents (const PContainer *src)
	Create a duplicate of the container contents. More...
void	Destruct ()
	Internal function called from container destructors. More...
virtual void	DestroyReference ()
	Destroy the PContainerReference instance. More...
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PIPSocketAddressAndPort	m_sourceAddressAndPort
Protected Attributes inherited from PAbstractArray
PINDEX	elementSize
	Size of an element in bytes. More...
char *	theArray
	Pointer to the allocated block of memory. More...
PBoolean	allocatedDynamically
	Flag indicating the array was allocated on the heap. More...
Protected Attributes inherited from PContainer
PContainerReference *	reference
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject *from)
static __inline const char *	Class ()
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Member Enumeration Documentation

enum PSTUNMessage::MsgType

Enumerator
InvalidMessage
BindingRequestRFC3489
BindingRequest
BindingResponse
BindingError
SharedSecretRequest
SharedSecretResponse
SharedSecretError
Allocate
AllocateResponse
AllocateError
Refresh
RefreshResponse
RefreshError
Send
Data
CreatePermission
CreatePermResponse
CreatePermError
ChannelBind
ChannelBindResponse
ChannelBindError
Connect
ConnectResponse
ConnectError
ConnectionBind
ConnectionBindResponse
ConnectionBindError
ConnectionAttempt

Constructor & Destructor Documentation

PSTUNMessage::PSTUNMessage

(

)

PSTUNMessage::PSTUNMessage	(	MsgType	newType,
		const BYTE *	id = NULL
	)

PSTUNMessage::PSTUNMessage	(	const BYTE *	data,
		PINDEX	size,
		const PIPSocketAddressAndPort &	srcAddr
	)

Member Function Documentation

PSTUNAttribute* PSTUNMessage::AddAttribute

(

const PSTUNAttribute &

attribute

)

void PSTUNMessage::AddFingerprint

(

PSTUNFingerprint *

fp = NULL

)

DWORD PSTUNMessage::CalculateFingerprint ( PSTUNFingerprint *  fp ) const

protected

bool PSTUNMessage::CheckFingerprint

(

bool

required

)

const

PSTUNAttribute* PSTUNMessage::FindAttribute

(

PSTUNAttribute::Types

type

)

const

template<class Type >

Type* PSTUNMessage::FindAttributeAs ( PSTUNAttribute::Types  type ) const

inline

Referenced by PSTUNAttributeTemplate< ATTR_TYPE, PARAMS_TYPE >::Find().

PString PSTUNMessage::FindAttributeString	(	PSTUNAttribute::Types	type,
		const char *	dflt = NULL
	)		const

PSTUNAttribute* PSTUNMessage::GetFirstAttribute ( ) const

protected

const PIPSocketAddressAndPort PSTUNMessage::GetSourceAddressAndPort ( ) const

inline

PBYTEArray PSTUNMessage::GetTransactionID

(

)

const

MsgType PSTUNMessage::GetType

(

)

const

bool PSTUNMessage::IsErrorResponse ( ) const

inline

bool PSTUNMessage::IsIndication ( ) const

inline

bool PSTUNMessage::IsRequest ( ) const

inline

bool PSTUNMessage::IsRFC5389

(

)

const

bool PSTUNMessage::IsSuccessResponse ( ) const

inline

bool PSTUNMessage::IsValid

(

)

const

bool PSTUNMessage::IsValidFor

(

const PSTUNMessage &

request

)

const

const PSTUNMessageHeader* PSTUNMessage::operator-> ( ) const

inline

bool PSTUNMessage::Poll	(	PUDPSocket &	socket,
		const PSTUNMessage &	request,
		PINDEX	pollRetries
	)

bool PSTUNMessage::Read

(

PUDPSocket &

socket

)

PSTUNAttribute* PSTUNMessage::SetAttribute

(

const PSTUNAttribute &

attribute

)

void PSTUNMessage::SetErrorType	(	int	code,
		const BYTE *	id,
		const char *	reason = NULL
	)

void PSTUNMessage::SetType	(	MsgType	newType,
		const BYTE *	id = NULL
	)

bool PSTUNMessage::Write

(

PUDPSocket &

socket

)

const

bool PSTUNMessage::Write	(	PUDPSocket &	socket,
		const PIPSocketAddressAndPort &	ap
	)		const

Member Data Documentation

PIPSocketAddressAndPort PSTUNMessage::m_sourceAddressAndPort

protected

---

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

• pstun.h