LDataArrived

LDataArrived is a PowerPlant class that assists in the task of sending a message when data arrives via an asynchronous channel.

Methods :

The methods in this class are:

LDataArrived()	~LDataArrived()
GetDataBuffer()	GetDataSize()
GetRemoteAddress()

Data Members:

The data members in this class are:

mDataBuffer	mDataSize
mRemoteAddress	mMustReleaseMemory

Source files:

(Networking Classes)

UNetworkMessages.h

UNetworkMessages.cp

See also:

LNetMessage

LRMPObject

LDataArrived()

Purpose:

The constructor creates the object.

Access :

Prototype:

LDataArrived(

	ResultT inResultCode,

	void* inDataBuffer,

	UInt32 inDataSize,

	LInternetAddress* inRemoteAddress,

	Boolean inMustReleaseMemory,

	LEndpoint* inEndpoint );

LDataArrived(); /* do not use */

LDataArrived(LDataArrived&); /* do not use */

The parameters for this constructor are:

MessageT	inMessageType	The message.
ResultT	inResultCode	The result code.
void*	inDataBuffer	The buffer.
UInt32	inDataSize	The size of the data.
LInternetAddress*	inRemoteAddress	The remote address.
Boolean	inMustReleaseMemory	Whether to release memory or not.
LEndpoint*	inEndpoint	The network endpoint.

~LDataArrived()

Purpose:

The destructor destroys the object.

Access :

Virtual, Public

Prototype:

virtual ~LDataArrived();

GetDataBuffer()

Purpose:

Retrieve the value of the mDataBuffer data member.

Access :

Public

Prototype:

void* GetDataBuffer() const;

None

Return:

Returns the value of mDataBuffer.

GetDataSize()

Purpose:

Retrieve the size of the data, held in the mDataSize data member.

Access :

Public

Prototype:

UInt32 GetDataSize() const;

None

Return:

The value of mDataSize.

GetRemoteAddress()

Purpose:

Retrieve the value of the mRemoteAddress data member.

Access :

Public

Prototype:

LInternetAddress* GetRemoteAddress() const;

None

Return:

The address, held in mRemoteAddress.

mDataBuffer

Purpose:

The data buffer.

Access :

Protected

Prototype:

void* mDataBuffer;

mDataSize

Purpose:

The size of the data.

Access :

Protected

Prototype:

UInt32 mDataSize;

mRemoteAddress

Purpose:

The address.

Access :

Protected

Prototype:

LInternetAddress* mRemoteAddress;

mMustReleaseMemory

Purpose:

Whether to release memory or not.

Access :

Protected

Prototype:

Boolean mMustReleaseMemory;