BComms.h

Go to the documentation of this file.

/*******************************************************************************
 *  BComms.h    BComms class
 *  T.Barnaby,  Beam Ltd,   2012-11-12
 *  Copyright (c) 2012 All Right Reserved, Beam Ltd, http://www.beam.ltd.uk
 *******************************************************************************
 *
 * For license see LICENSE.txt at the root of the beamlib source tree.
 */
#ifndef BComms_h
#define BComms_h
 
#include <BTypes.h>
#include <BEvent.h>
#include <BError.h>
 
class BComms {
public:
    enum Flush      { FlushRead, FlushWrite, FlushReadWrite };
 
                BComms();
    virtual         ~BComms();
 
    virtual BError      init();
    virtual void        close();
    
    virtual const char* name();                             
    virtual BUInt32     byteRate();                         
        
    virtual BError      setPacketMode(Bool packetMode);                 
    virtual Bool        packetMode();                           
    virtual BError      setTimeout(BTimeout timeoutUs);                 
 
    virtual BError      connect(const char* resource);                  
    virtual Bool        isConnected();
    virtual BError      disconnect();                           
    
    virtual void        flush(Flush flush);
 
    virtual BUInt       writeAvailable();
    virtual BError      write(const void* data, BUInt32 nBytes, BUInt32& nTrans) = 0;
    virtual BError      writeChunks(const BDataChunk* chunks, BUInt nChunks, BUInt32& nTrans);
 
    virtual BUInt       readAvailable();
    virtual BError      read(void* data, BUInt32 num, BUInt32& nTrans) = 0;
 
    virtual BError      wait(BUInt32 eventSet, BTimeout timeoutUs = BTimeoutForever, BUInt32 num = 1);
    virtual void        eventQueue(BEventQueue* eventQueue, BUInt32 event, BUInt32 eventSet, BUInt num = 1);
    virtual void        eventEnable(Bool on);                       
 
protected:
    Bool            oconnected;
    Bool            opacketMode;
    BTimeout        otimeout;
    BEventQueue*        oeventQueue;
    Bool            oeventEnabled;
    BUInt32         oevent;
    BUInt32         oeventSet;
    BUInt           oeventNum;
};
#endif