OpenNet::PacketGenerator Class Reference

The PacketGenerator class. More...

#include <PacketGenerator.h>

Classes
struct	Config
	PacketGenerator configuration. More...

Public Types
enum	Protocol
	This enum indicate the protocol. More...

Public Member Functions
virtual Status	GetConfig (Config *aOut) const =0
	Retrieve the configuration of the PacketGenerator. More...
virtual Status	ResetConfig ()=0
	Reset the configuration of the PacketGenerator. More...
virtual Status	SetAdapter (Adapter *aAdapter)=0
	Connect an Adapter to the PacketGenerator. More...
virtual Status	SetConfig (const Config &aConfig)=0
	Modify the configuration of the PacketGenerator. More...
virtual void	Delete ()
	This methode delete the instance. More...
virtual Status	Display (FILE *aOut)=0
	Display. More...
virtual Status	Start ()=0
	Start. More...
virtual Status	Stop ()=0
	Stop. More...

Static Public Member Functions
static OPEN_NET_PUBLIC PacketGenerator *	Create ()
	This static methode create an instance of the PacketGenerator class. More...
static OPEN_NET_PUBLIC Status	Display (const Config &aConfig, FILE *aOut)
	This static methode display the PacketGenerator. More...

Detailed Description

The PacketGenerator class.

Member Enumeration Documentation

enum OpenNet::PacketGenerator::Protocol

This enum indicate the protocol.

Todo:

Document the values

Member Function Documentation

static OPEN_NET_PUBLIC PacketGenerator* OpenNet::PacketGenerator::Create ( )

static

This static methode create an instance of the PacketGenerator class.

Returns

This static methode return the new instance address.

See also

Delete

virtual void OpenNet::PacketGenerator::Delete ( )

virtual

This methode delete the instance.

See also

Create

static OPEN_NET_PUBLIC Status OpenNet::PacketGenerator::Display ( const Config &  aConfig, FILE *  aOut  )

static

This static methode display the PacketGenerator.

Parameters

aConfig	The configuration
aOut	The output stream

Return values

STATUS_OK
STATUS_INVALID_REFERENCE
STATUS_NOT_ALLOWER_NULL_ARGUMENT

virtual Status OpenNet::PacketGenerator::Display ( FILE *  aOut )

pure virtual

Display.

Parameters

aOut	The output stream

Return values

STATUS_OK

virtual Status OpenNet::PacketGenerator::GetConfig ( Config *  aOut ) const

pure virtual

Retrieve the configuration of the PacketGenerator.

Parameters

aOut	The output space

Return values

STATUS_OK
STATUS_NOT_ALLOWER_NULL_ARGUMENT

See also

ResetConfig, SetConfig

virtual Status OpenNet::PacketGenerator::ResetConfig ( )

pure virtual

Reset the configuration of the PacketGenerator.

Return values

STATUS_OK

See also

GetConfig, SetConfig

virtual Status OpenNet::PacketGenerator::SetAdapter ( Adapter *  aAdapter )

pure virtual

Connect an Adapter to the PacketGenerator.

Parameters

aAdapter

The Adapter

Return values

STATUS_OK

virtual Status OpenNet::PacketGenerator::SetConfig ( const Config &  aConfig )

pure virtual

Modify the configuration of the PacketGenerator.

Parameters

aConfig

The configuration

Return values

STATUS_OK
STATUS_INVALID_REFERENCE

See also

GetConfig, ResetConfig

virtual Status OpenNet::PacketGenerator::Start ( )

pure virtual

Start.

Return values

STATUS_OK

virtual Status OpenNet::PacketGenerator::Stop ( )

pure virtual

Stop.

Return values

STATUS_OK

---

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

• Includes/OpenNet/PacketGenerator.h