Connection.h

Go to the documentation of this file.

#if !defined(CONNECTION_CONNECTION_H) && !defined(CONTAINS_CONNECTION)

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

enum ConnectionStatus
{
    Connected,      
    Disconnected,   
    ConnectionFault 
};
typedef enum ConnectionStatus ConnectionStatus;

typedef struct ConnectionMessage ConnectionMessage;
struct ConnectionMessage
{
    ConnectionStatus ConnectionStatus; 
    uint32_t         ErrorCode;        
    void         ( * Destructor)(ConnectionMessage * self); 
};

#ifdef __cplusplus
extern "C"
{
#endif // __cplusplus

DLLINTERNAL ConnectionMessage * ConnectionMessage_New (
    ConnectionStatus connectionStatus, uint32_t errorCode);

#ifdef __cplusplus
}
#endif // __cplusplus

typedef struct Connection Connection;
struct Connection
{
#endif // !defined(CONNECTION_CONNECTION_H) && !defined(CONTAINS_CONNECTION)
#if !defined(CONNECTION_CONNECTION_H) || defined(CONTAINS_CONNECTION)
    zForce         * zForce;                   
    Transport      * Transport;                
    Protocol       * Protocol;                 
    Queue          * ConnectionQueue;          
    Queue          * DeviceQueue;              
    Device        ** Devices;                  
    uint32_t         NumberOfDevices;          
    bool             IsConnected;              
    zForceMutex    * MessageFilterMutex;       
    Device         * FilterDevice;             
    MessageType      FilterMessageType;        
    uint64_t         LastResponseSerialNumber; 

    void         ( * Destructor)(Connection * self);
    bool         ( * AddDevice)(Connection * self, Device * device);
    Device *     ( * FindDevice)(Connection * self, DeviceType deviceType, uint32_t deviceIndex);
    bool         ( * ReceiveDataFrame)(Connection * self, DataFrame * dateFrame);
    bool         ( * SendDataFrame)(Connection * self, DataFrame * dataFrame);
    bool         ( * SetMessageFilter)(Connection * self, Device * device, MessageType messageType);
    void         ( * ClearMessageFilter)(Connection * self);
    bool         ( * EnqueueMessage)(Connection * self, Device * device, Message * message);
    bool         ( * Connect)(Connection * self);
    bool         ( * Disconnect)(Connection * self);
    void         ( * UnknownCommand)(Connection * self);
    void         ( * Timeout)(Connection * self);
    void         ( * SetTimeout)(Connection * self, uint64_t relativeTimeoutMilliSeconds);
    void         ( * SignalConnectionEstablished)(Connection * self);
    void         ( * SignalConnectionFault)(Connection * self);

    ConnectionStatus Status;
#endif // !defined(CONNECTION_CONNECTION_H) || defined(CONTAINS_CONNECTION)
#if !defined(CONNECTION_CONNECTION_H) && !defined(CONTAINS_CONNECTION)
};

#ifdef __cplusplus
extern "C"
{
#endif // __cplusplus

DLLEXTERNAL Connection * Connection_New (char * connectionString,
                                         char * protocolString,
                                         char * dataFrameType);

#ifdef __cplusplus
}
#endif // __cplusplus

#define CONNECTION_CONNECTION_H
#endif // !defined(CONNECTION_CONNECTION_H) && !defined(CONTAINS_CONNECTION)