Cette classe définit l'interface au niveau de l'adaptateur. Plus de détails...

#include <Adapter.h>

Graphe d'héritage de OpenNet::Adapter:

Classes
struct	Config
	La configuration. Plus de détails...

Fonctions membres publiques
virtual Status	GetAdapterNo (unsigned int *aOut)=0
	Cette méthode retourne le numero de l'adaptateur. Plus de détails...

virtual Status	GetConfig (Config *aOut) const =0
	Cette méthode retourne la configuration de l'adaptateur. Plus de détails...

virtual Status	GetInfo (Info *aOut) const =0
	Cette méthode retourne les informations au sujet de l'adaptateur. Plus de détails...

virtual const char *	GetName () const =0
	Cette méthode retourne le nom de l'adaptateur. Plus de détails...

virtual Status	GetState (State *aOut)=0
	Cette méthode retourne l'état de l'adaptateur. Plus de détails...

virtual bool	IsConnected ()=0
	Cette méthode indique si l'adaptateur est connecté à un système. Plus de détails...

virtual bool	IsConnected (const System &aSystem)=0
	Cette méthode indique si l'adaptateur est connecté au système. Plus de détails...

virtual Status	ResetInputFilter ()=0
	Cette méthode retire le filtre d'entré. Plus de détails...

virtual Status	ResetProcessor ()=0
	Cette méthode retire le processeur. Plus de détails...

virtual Status	SetConfig (const Config &aConfig)=0
	Cette méthode change la configuration. Plus de détails...

virtual Status	SetInputFilter (SourceCode *aSourceCode)=0
	Cette méthode affecte le filtre d'entr&eacute. Plus de détails...

virtual Status	SetProcessor (Processor *aProcessor)=0
	Cette méthode associe un processeur à l'adaptateur. Plus de détails...

virtual Status	Display (FILE *aOut) const =0
	Afficher. Plus de détails...

virtual Status	Event_RegisterCallback (Event_Callback aCallback, void *aContext)=0
	Attendre pour des evennements. Plus de détails...

virtual Status	Packet_Send (const void *aData, unsigned int aSize_byte)=0
	Cette méthode transmet un paquet. Plus de détails...

virtual Status	Read (void aOut, unsigned int aOutSize_byte, unsigned int aInfo_byte)=0
	Cette méthode lit des données du pilote. Plus de détails...

virtual Status	Tx_Disable ()=0
	Cette méthode désactive la transmission. Plus de détails...

virtual Status	Tx_Enable ()=0
	Cette méthode active la transmission. Plus de détails...

Fonctions membres publiques hérités de OpenNet::StatisticsProvider
virtual Status	GetStatistics (unsigned int aOut, unsigned int aOutSize_byte, unsigned int aInfo_byte=NULL, bool aReset=false)=0
	Cette méthode retourne les statistiques de l'adaptateur. Plus de détails...

OPEN_NET_PUBLIC unsigned int	GetStatisticsQty () const
	Cette méthode retourne le nombre de compteurs statistiques. Plus de détails...

const OPEN_NET_PUBLIC StatisticsDescription *	GetStatisticsDescriptions () const
	Cette méthode retourne les descriptions des compteurs de statistiques. Plus de détails...

virtual Status	ResetStatistics ()=0
	Cette méthode remet à zéro les compteurs de statistiques de l'adaptateur. Plus de détails...

OPEN_NET_PUBLIC Status	DisplayStatistics (const unsigned int aIn, unsigned int aInSize_byte, FILE aOut, unsigned int aMinLevel=0)
	Afficher. Plus de détails...

Fonctions membres publiques statiques
static OPEN_NET_PUBLIC Status	Display (const Config &aIn, FILE *aOut)
	Afficher. Plus de détails...

static OPEN_NET_PUBLIC Status	Display (const Info &aIn, FILE *aOut)
	Affiche. Plus de détails...

static OPEN_NET_PUBLIC Status	Display (const State &aIn, FILE *aOut)
	Affiche. Plus de détails...

Description détaillée

Cette classe définit l'interface au niveau de l'adaptateur.

Documentation des fonctions membres

static OPEN_NET_PUBLIC Status OpenNet::Adapter::Display	(	const Config &	aIn,
		FILE *	aOut
	)

static

Afficher.

Paramètres

aIn	L'instance de Config à afficher
aOut	Le fichier de sortie

Valeurs retournées

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT
STATUS_INVALID_REFERENCE

static OPEN_NET_PUBLIC Status OpenNet::Adapter::Display	(	const Info &	aIn,
		FILE *	aOut
	)

static

Affiche.

Paramètres

aIn	L'instance de Info à afficher
aOut	Le fichier de sortie

Valeurs retournées

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT
STATUS_INVALID_REFERENCE

static OPEN_NET_PUBLIC Status OpenNet::Adapter::Display	(	const State &	aIn,
		FILE *	aOut
	)

static

Affiche.

Paramètres

aIn	L'instance de State à afficher
aOut	Le fichier de sortie

Valeurs retournées

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT
STATUS_INVALID_REFERENCE

virtual Status OpenNet::Adapter::Display ( FILE * aOut ) const

pure virtual

Afficher.

Paramètres

aOut	Le fichier de sortie

Valeurs retournées

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT

virtual Status OpenNet::Adapter::Event_RegisterCallback	(	Event_Callback	aCallback,
		void *	aContext
	)

pure virtual

Attendre pour des evennements.

Paramètres

aCallback	La fonction de traitement des événements. Passer NULL pour annuler l'enregistrement.
aContext	La contexte passé à la fonction

Valeurs retournées

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT

virtual Status OpenNet::Adapter::GetAdapterNo ( unsigned int * aOut )

pure virtual

Cette méthode retourne le numero de l'adaptateur.

Paramètres

aOut	La medhode retourne l'information ici.

Valeurs retournées

STATUS_OK
STATUS_ADAPTER_NOT_CONNECTED
STATUS_NOT_ALLOWED_NULL_ARGUMENT

Voir également: IsConnected

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

pure virtual

Cette méthode retourne la configuration de l'adaptateur.

Paramètres

aOut	La médhode retourne les informations ici.

Valeurs retournées

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT

Voir également: SetConfig

virtual Status OpenNet::Adapter::GetInfo ( Info * aOut ) const

pure virtual

Cette méthode retourne les informations au sujet de l'adaptateur.

Paramètres

aOut	La méthode retourne les informations ici.

Valeurs retournées

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT

virtual const char* OpenNet::Adapter::GetName ( ) const

pure virtual

Cette méthode retourne le nom de l'adaptateur.

Valeurs retournées

Cette méthode retourne l'adresse d'un espace mémoire interne.

virtual Status OpenNet::Adapter::GetState ( State * aOut )

pure virtual

Cette méthode retourne l'état de l'adaptateur.

Paramètres

aOut	La méthode retourne les informations ici.

Valeurs retournées

STATUS_OK
STATUS_IOCTL_ERROR
STATUS_NOT_ALLOWED_NULL_ARGUMENT

virtual bool OpenNet::Adapter::IsConnected ( )

pure virtual

Cette méthode indique si l'adaptateur est connecté à un système.

Valeurs retournées

false
true

Voir également: GetAdapterNo

virtual bool OpenNet::Adapter::IsConnected ( const System & aSystem )

pure virtual

Cette méthode indique si l'adaptateur est connecté au système.

Paramètres

aSystem L'instance de System

Valeurs retournées

false
true

Voir également: GetAdapterNo

virtual Status OpenNet::Adapter::Packet_Send	(	const void *	aData,
		unsigned int	aSize_byte
	)

pure virtual

Cette méthode transmet un paquet.

Paramètres

aData	Les donnees
aSize_byte	La taille

Valeurs retournées

STATUS_OK
STATUS_IOCTL_ERROR
STATUS_NOT_ALLOWER_NULL_ARGUMENT
STATUS_PACKET_TO_LARGE
STATUS_PACKET_TO_SMALL

virtual Status OpenNet::Adapter::Read	(	void *	aOut,
		unsigned int	aOutSize_byte,
		unsigned int *	aInfo_byte
	)

pure virtual

Cette méthode lit des données du pilote.

Paramètres

aOut	L'espace de sortie
aOutSize_byte	La taille de l'espace de sortie
aInfo_byte	La méthode place la taille des données lues ici

Valeurs retournées

STATUS_OK

virtual Status OpenNet::Adapter::ResetInputFilter ( )

pure virtual

Cette méthode retire le filtre d'entré.

Valeurs retournées

STATUS_OK
STATUS_FILTER_NOT_SET

Voir également: SetInputFilter

virtual Status OpenNet::Adapter::ResetProcessor ( )

pure virtual

Cette méthode retire le processeur.

Valeurs retournées

STATUS_OK
STATUS_PROCESSOR_NOT_SET

Voir également: SetProcessor

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

pure virtual

Cette méthode change la configuration.

Paramètres

aConfig L'instance de Config

Valeurs retournées

STATUS_OK
STATUS_INVALID_REFERENCE
STATUS_IOCTL_ERROR

Voir également: GetConfig

virtual Status OpenNet::Adapter::SetInputFilter ( SourceCode * aSourceCode )

pure virtual

Cette méthode affecte le filtre d'entr&eacute.

Paramètres

aSourceCode L'instance de SourceCode

Valeurs retournées

STATUS_OK
STATUS_FILTER_ALREADY_SET
STATUS_NOT_ALLOWED_NULL_ARGUMENT
STATUS_PROCESSOR_NOT_SET

Voir également: ResetInputFilter

virtual Status OpenNet::Adapter::SetProcessor ( Processor * aProcessor )

pure virtual

Cette méthode associe un processeur à l'adaptateur.

Paramètres

aProcessor L'intance de Processor

Valeurs retournées

STATUS_OK
STATUS_INVALID_PROCESSOR
STATUS_NOT_ALLOWED_NULL_ARGUMENT
STATUS_PROCESSOR_ALREADY_SET

Voir également: ResetProcessor

virtual Status OpenNet::Adapter::Tx_Disable ( )

pure virtual

Cette méthode désactive la transmission.

Valeurs retournées

STATUS_OK

virtual Status OpenNet::Adapter::Tx_Enable ( )

pure virtual

Cette méthode active la transmission.

Valeurs retournées

STATUS_OK

La documentation de cette classe a été générée à partir du fichier suivant :

Includes/OpenNet/Adapter.h

Classes

Fonctions membres publiques

Fonctions membres publiques statiques

Description détaillée

Documentation des fonctions membres