The Buffer class.
More...
#include <Buffer.h>
|
| virtual unsigned int | GetPacketCount () const =0 |
| | Retrieve the quantity of packet in the buffer. More...
|
| |
| virtual uint32_t | GetPacketDestination (unsigned int aIndex) const =0 |
| | Retrieve the packet destination. More...
|
| |
| virtual unsigned int | GetPacketEvent (unsigned int aIndex) const =0 |
| | Retrieve the index of the next packet event. More...
|
| |
| virtual unsigned int | GetPacketSize (unsigned int aIndex) const =0 |
| | Retrieve the packet size. More...
|
| |
| virtual OpenNet::Status | ClearEvent ()=0 |
| | Clear the event. More...
|
| |
| virtual OpenNet::Status | Display (FILE *aOut) const =0 |
| | Display. More...
|
| |
| virtual OpenNet::Status | ReadPacket (unsigned int aIndex, void *aOut, unsigned int aOutSize_byte)=0 |
| | Read packet. More...
|
| |
| virtual OpenNet::Status | Wait ()=0 |
| | Wait until all ReadPacket or ClearEvent operations are completed. More...
|
| |
| virtual OpenNet::Status OpenNet::Buffer::ClearEvent |
( |
| ) |
|
|
pure virtual |
Clear the event.
- Return values
-
| virtual OpenNet::Status OpenNet::Buffer::Display |
( |
FILE * |
aOut | ) |
const |
|
pure virtual |
Display.
- Parameters
-
- Return values
-
| virtual unsigned int OpenNet::Buffer::GetPacketCount |
( |
| ) |
const |
|
pure virtual |
Retrieve the quantity of packet in the buffer.
- Returns
- This methode returns the packet count.
| virtual uint32_t OpenNet::Buffer::GetPacketDestination |
( |
unsigned int |
aIndex | ) |
const |
|
pure virtual |
Retrieve the packet destination.
- Parameters
-
- Returns
- This methode returns a bit field indicating where the packet has been forwarded.
| virtual unsigned int OpenNet::Buffer::GetPacketEvent |
( |
unsigned int |
aIndex | ) |
const |
|
pure virtual |
Retrieve the index of the next packet event.
- Parameters
-
| aIndex | Start searching at this index |
- Returns
- This methode returns the index of the packet marked for event processing or 0xffffffff if no other packet are marked.
| virtual unsigned int OpenNet::Buffer::GetPacketSize |
( |
unsigned int |
aIndex | ) |
const |
|
pure virtual |
Retrieve the packet size.
- Parameters
-
- Returns
- This methode returns the packet size in byte.
| virtual OpenNet::Status OpenNet::Buffer::ReadPacket |
( |
unsigned int |
aIndex, |
|
|
void * |
aOut, |
|
|
unsigned int |
aOutSize_byte |
|
) |
| |
|
pure virtual |
Read packet.
- Parameters
-
| aIndex | Packet index |
| aOut | The output buffer |
| aOutSize_byte | The output buffer size |
- Return values
-
| virtual OpenNet::Status OpenNet::Buffer::Wait |
( |
| ) |
|
|
pure virtual |
Wait until all ReadPacket or ClearEvent operations are completed.
- Return values
-
The documentation for this class was generated from the following file:
