Adapter.h

Go to the documentation of this file.

// Product  OpenNet


#pragma once

// Includes

// ===== Includes ===========================================================
#include <OpenNet/Processor.h>
#include <OpenNet/StatisticsProvider.h>
#include <OpenNetK/Adapter_Types.h>

namespace OpenNet
{

    class SourceCode;
    class System    ;

    // Class

    class Adapter : public StatisticsProvider
    {

    public:

        typedef struct
        {
            unsigned int mBufferQty      ;
            unsigned int mPacketSize_byte;

            // TODO  OpenNet.Adapter
            //       Normal (Feature) - Ajouter un "Buffer Factor" pour
            //       allouer un multiple du multiple prefere du Kernel
            //       (division ou multiplication).

            unsigned char mReserved0[1016];
        }
        Config;

        typedef OpenNetK::Adapter_Info   Info  ;
        typedef OpenNetK::Adapter_State  State ;

        typedef void(*Event_Callback)(void * aContext, const OpenNetK::Event_Type aType, uint64_t aTimestamp_us, uint32_t aData0, void * aData1);

        static OPEN_NET_PUBLIC Status Display(const Config & aIn, FILE * aOut);

        static OPEN_NET_PUBLIC Status Display(const Info & aIn, FILE * aOut);

        static OPEN_NET_PUBLIC Status Display(const State & aIn, FILE * aOut);

        virtual Status GetAdapterNo(unsigned int * aOut) = 0;

        virtual Status GetConfig(Config * aOut) const = 0;

        virtual Status GetInfo(Info * aOut) const = 0;

        virtual const char * GetName() const = 0;

        virtual Status GetState(State * aOut) = 0;

        virtual bool IsConnected() = 0;

        virtual bool IsConnected(const System & aSystem) = 0;

        // TODO  OpenNet.Adapter
        //       Normal (Feature) - Ajouter ResetConfig

        virtual Status ResetInputFilter() = 0;

        virtual Status ResetProcessor() = 0;

        virtual Status SetConfig(const Config & aConfig) = 0;

        virtual Status SetInputFilter(SourceCode * aSourceCode) = 0;

        virtual Status SetProcessor(Processor * aProcessor) = 0;

        virtual Status Display(FILE * aOut) const = 0;

        virtual Status Event_RegisterCallback(Event_Callback aCallback, void * aContext) = 0;

        virtual Status Packet_Send(const void * aData, unsigned int aSize_byte) = 0;

        virtual Status Read(void * aOut, unsigned int aOutSize_byte, unsigned int * aInfo_byte) = 0;

        virtual Status Tx_Disable() = 0;

        virtual Status Tx_Enable() = 0;

    protected:

        Adapter();

    private:

        Adapter(const Adapter &);

        const Adapter & operator = (const Adapter &);

    };

}