BoapMc.h

Go to the documentation of this file.

/*******************************************************************************
 *  BoapMc.h    BoapMc RPC protocol
 *  T.Barnaby,  BEAM Ltd,   2012-11-14
 *  Copyright (c) 2022 All Right Reserved, Beam Ltd, https://www.beam.ltd.uk
 *  For license see LICENSE.txt at the root of the beamlib source tree.
 *******************************************************************************
 */
#ifndef BoapMc_HH
#define BoapMc_HH
 
#include <BTypes.h>
#include <BMutex.h>
#include <BSemaphore.h>
#include <BQueue.h>
#include <BFifo.h>
#include <BComms.h>
 
// Main BOAP Types
enum BoapMcType     { BoapMcTypeRequest = 0x00, BoapMcTypeReply = 0x80 };
 
// BoapMc packet header
struct BoapMcPacketHead {
    BUInt8      length;
    BUInt8      addressTo;
    BUInt8      addressFrom;
    BUInt8      cmd;
    BUInt16     error;
    BUInt16     checksum;
} __attribute__((aligned(8),packed));
 
// BoapMc packet
class BoapMcPacket {
public:
    BoapMcPacketHead    head;
    char            data[256 - sizeof(BoapMcPacketHead)];
};
 
/*******************************************************************************
 *  Base for all client interface objects
 *******************************************************************************
 */
class BoapMcClientObject {
public:
            BoapMcClientObject(BComms& comms);
    virtual     ~BoapMcClientObject();
 
    void        setAddress(BUInt8 addressTo, BUInt8 addressFrom);
    BUInt32     getApiVersion();            
 
protected:
    BError      performCall();              
    BError      performSend();              
    BError      performRecv();              
 
    BUInt32     oapiVersion;
    BComms&     ocomms;
    BUInt8      oaddressTo;
    BUInt8      oaddressFrom;
    BoapMcPacket    opacket;
};
 
class BoapMcSignalObject {
public:
            BoapMcSignalObject(BComms& comms);
 
protected:
    BError      performSend(BoapMcPacket& tx);          // Performs a send to the named service
    BComms&     ocomms;
};
 
 
/*******************************************************************************
 *  Base for server communications objects
 *******************************************************************************
 */
class BoapMcServiceObject {
public:
            BoapMcServiceObject();
    virtual     ~BoapMcServiceObject();
 
    virtual BError  process(BoapMcPacket& rx, BoapMcPacket& tx);
    virtual BError  processEvent(BoapMcPacket& rx);
protected:
    BError      sendEvent(BoapMcPacket& tx);
    BUInt32     oapiVersion;
};
 
/*******************************************************************************
 *  Base for bidirectional communications objects
 *******************************************************************************
 */
class BoapMcComms {
public:
            BoapMcComms(Bool threaded = 0, BUInt rxQueueSize = 4);
    virtual     ~BoapMcComms();
 
    void        setCommsMode(Bool slave, BUInt txQueueSize);        
    void        setComms(BComms& comms);                
    void        setComms(BComms* comms);                
    void        setAddress(BUInt8 addressTo, BUInt8 addressFrom);   
    BUInt32     getApiVersion();                    
    BUInt32     setTimeout(BUInt32 timeoutUs);              
 
    virtual BError  processRx(BTimeout timeoutUs = BTimeoutForever);    
    virtual BError  processRequests(BTimeout timeoutUs = BTimeoutForever);  
    virtual BError  processRequest(BTimeout timeoutUs = BTimeoutForever);   
    virtual BError  processPacket(BoapMcPacket& rx, BoapMcPacket& tx);  
 
protected:
    // Communications functions
    BError      performCall();                      
    BError      performSend();                      
 
    BError      packetSend(BoapMcPacket& packet);           
    BError      packetRecv(BoapMcPacket& packet);           
 
    Bool            othreaded;
    BMutex          olockCall;              
    BMutex          olockTx;                
    BComms*         ocomms;
    BUInt32         oapiVersion;
    Bool            oslave;                 
    BUInt32         otimeout;               
    BUInt8          oaddressTo;
    BUInt8          oaddressFrom;
    BoapMcPacket        opacket;                
    BoapMcPacket        opacketTx;              
    BoapMcPacket        opacketRx;              
    BSemaphore      opacketRxSema;              
    BoapMcPacket        opacketReqTx;               
    BoapMcPacket        opacketReqRx;               
    BQueue<BoapMcPacket>    opacketReqQueue;            
 
    BFifo<BoapMcPacket> opacketTxQueue;             
    BSemaphoreCount     opacketTxQueueWriteNum;         
    BSemaphore      opacketTxSema;              
};
 
 
#endif