OpenNet
Public Member Functions | List of all members
OpenNet::UserBuffer Class Referenceabstract

The UserBuffer class. More...

#include <UserBuffer.h>

Public Member Functions

virtual OpenNet::Status Clear ()=0
 Initialise the buffer to 0.
 
virtual OpenNet::Status Read (unsigned int aOffset_byte, void *aOut, unsigned int aSize_byte)=0
 Read data from a UserBuffer. More...
 
virtual OpenNet::Status Write (unsigned int aOffset_byte, const void *aIn, unsigned int aSize_byte)=0
 Write data to a UserBuffer. More...
 
virtual void Delete ()
 Delete the instance.
 

Detailed Description

The UserBuffer class.

Member Function Documentation

virtual OpenNet::Status OpenNet::UserBuffer::Read ( unsigned int  aOffset_byte,
void *  aOut,
unsigned int  aSize_byte 
)
pure virtual

Read data from a UserBuffer.

Parameters
aOffset_byteWhere to start to read in the UserBuffer
aOutWhere to put read data
aSize_byteSize of data to read
Return values
STATUS_OK
virtual OpenNet::Status OpenNet::UserBuffer::Write ( unsigned int  aOffset_byte,
const void *  aIn,
unsigned int  aSize_byte 
)
pure virtual

Write data to a UserBuffer.

Parameters
aOffset_byteWhere to start to write in the UserBuffer
aInWhere to get the data to write
aSize_byteSize of data to read
Return values
STATUS_OK

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