Transport.h

Go to the documentation of this file.

#ifndef TRANSPORT_TRANSPORT_H
#define TRANSPORT_TRANSPORT_H

#ifndef ZFORCECOMMON_H
    #error Please include "zForceCommon.h" before this file.
#endif // ZFORCECOMMON_H

typedef enum ReadWriteThreadStatus ReadWriteThreadStatus;
enum ReadWriteThreadStatus
{
    ThreadIsNotRunning,   
    ThreadIsInitializing, 
    ThreadIsRunning,      
    ThreadIsTerminating   
};

/*
 * Forward declaration required in order to break the cycle where
 * Transport needs TransportEntry, and
 * TransportEntry needs Transport.
 */
typedef struct TransportEntry TransportEntry;

typedef struct Transport Transport;
struct Transport
{
    Transport           * Base;
    Connection          * Connection;
    zForce              * zForce;
    char                  ConnectionString
                            [TRANSPORTPROTOCOL_MaxOptionParameterLength + 1];
    bool                  Terminate;
    Queue               * WriteQueue;
    bool                  IsOpen;
    bool                  Opening;           
    zForceThread        * WriteThread;       
    zForceThread        * ReadThread;        
    volatile ReadWriteThreadStatus WriteThreadStatus; 
    volatile ReadWriteThreadStatus ReadThreadStatus;  

    bool        ( * Open)(Transport * self);
    bool        ( * Close)(Transport * self);
    DataFrame * ( * Read)(Transport * self);
    bool        ( * Write)(Transport * self, DataFrame * payload);
    uint64_t    ( * GetTimeOutValue)(Transport * self);
    bool        ( * EnqueueDataFrame)(Transport * self, DataFrame * dataFrame);

    void        ( * Destructor )(Transport * self);
};

// Exported Functions (prefixed with module name and underscore)

DLLEXTERNAL Transport * Transport_GetInstance (Connection * connection,
                                               char * connectionString,
                                               char * dataFrameType);

DLLEXTERNAL bool Transport_AddTransport(TransportEntry * transportEntry);

DLLINTERNAL bool Transport_Initialize (void);

DLLINTERNAL void Transport_Uninitialize (void);

#ifdef USE_SERIALTRANSPORT
    DLLINTERNAL bool SerialTransport_AddSerialTransportEntry (void);
#endif //USE_SERIALTRANSPORT

#ifdef USE_HIDPIPETRANSPORT
    DLLINTERNAL bool HidPipeTransport_AddHidPipeTransportEntry (void);
#endif //USE_HIDPIPETRANSPORT

#endif // TRANSPORT_TRANSPORT_H