P3X GitList

6ae0d525

/******************************************************************************* * Boap.h Boap RPC protocol * T.Barnaby, BEAM Ltd, 8/5/03

57456599

6ae0d525

******************************************************************************* */ #ifndef Boap_HH #define Boap_HH #include <stdint.h>

57456599

#include <BTypes.h>

6ae0d525

#include <BPoll.h> #include <BSocket.h> #include <BThread.h> #include <BError.h>

57456599

#include <BEvent1.h>

6ae0d525

#include <BMutex.h>

57456599

#include <BTimeStamp.h> #include <BBuffer.h>

6ae0d525

// Main BOAP Types

57456599

const BUInt32 BoapMagic = 0x424F4100; enum BoapType { BoapTypeRpc, BoapTypeRpcReply, BoapTypeSignal, BoapTypeRpcError }; typedef BUInt32 BoapService;

6ae0d525

enum BoapPriority { BoapPriorityLow, BoapPriorityNormal, BoapPriorityHigh }; // Boap packet header struct BoapPacketHead {

57456599

BUInt32 type; BUInt32 length; BUInt32 service; BUInt32 cmd;

6ae0d525

}; // Boap packet

57456599

class BoapPacket : public BBufferStore {

6ae0d525

public: BoapPacket(); ~BoapPacket();

57456599

BUInt32 getCmd();

6ae0d525

57456599

int peekHead(BoapPacketHead& head);

6ae0d525

int pushHead(BoapPacketHead& head); int popHead(BoapPacketHead& head);

57456599

void updateHead();

6ae0d525

}; /******************************************************************************* * Main Client communications classes ******************************************************************************* */ /******************************************************************************* * Base for all Client Objects ******************************************************************************* */ class BoapClientObject : public BSocket { public: BoapClientObject(BString name = "");

57456599

virtual ~BoapClientObject();

6ae0d525

BError connectService(BString name); ///< Connects to the named service BError disconnectService(); ///< Disconnects from the named service BString getServiceName(); ///< Get the name of the service BError ping(BUInt32& apiVersion); ///< Pings the connection and finds the remotes version number BError setConnectionPriority(BoapPriority priority); ///< Sets the connection priority void setMaxLength(BUInt32 maxLength); ///< Sets the maximum packet length void setTimeout(int timeout); ///< Sets the timeout in micro seconds. -1 is wait indefinitely

57456599

6ae0d525

protected: BError pingLocked(BUInt32& apiVersion); BError checkApiVersion(); BError performCall(BoapPacket& tx, BoapPacket& rx); ///< Performs a RPC call to the named service BError performSend(BoapPacket& tx); ///< Performs a send to the named service BError performRecv(BoapPacket& rx); ///< Performs a receive

57456599

virtual BError handleReconnect(BError err); ///< Handle a reconnect performing autorisaztion if required

6ae0d525

BString oname; BUInt32 oapiVersion; BoapPriority opriority; BoapService oservice; int oconnected; BUInt32 omaxLength; BoapPacket otx; BoapPacket orx; BMutex olock; int otimeout;

57456599

int oreconnect; ///< Handle an automatic reconnect on timeout

6ae0d525

}; class BoapSignalObject : public BSocket { public: BoapSignalObject(); protected: BError performSend(BoapPacket& tx); // Performs a send to the named service BoapPacket otx; BoapPacket orx; }; /******************************************************************************* * Main Server communications class ******************************************************************************* */ class BoapServiceObject; class BoapServiceEntry { public: BoapServiceEntry(BoapService service = 0, BoapServiceObject* object = 0){ oservice = service; oobject = object; } BoapService oservice; BoapServiceObject* oobject; }; class BoapServer; class BoapServerConnection : public BThread { public: BoapServerConnection(BoapServer& boapServer, int fd);

57456599

virtual ~BoapServerConnection(); virtual BError init(); ///< Initialise connection virtual BError process(); virtual BSocket& getSocket(); virtual void setMaxLength(BUInt32 maxLength); virtual BError getHead(BoapPacketHead& head);

6ae0d525

57456599

virtual BError validate(); ///< Validate the connection

6ae0d525

private: void* function(); BoapServer& oboapServer; BSocket osocket; BoapPacket orx; BoapPacket otx; BUInt32 omaxLength; }; namespace Boapns { class Boapns; } class BoapServer : public BThread { public: enum { NOTHREADS=0, THREADED=1 };

57456599

BoapServer(); virtual ~BoapServer(); virtual BError init(BString boapNsHost = "", int port = 0, int threaded = 0, int isBoapns = 0); virtual BError run(int inThread = 0); virtual BError process(BoapServerConnection* conn, BoapPacket& rx, BoapPacket& tx); virtual BError processEvent(BoapPacket& rx);

6ae0d525

// Support routines

57456599

virtual BError addObject(BoapServiceObject* object); virtual BError sendEvent(BoapPacket& tx); virtual BError processEvent(int fd); virtual void clientGone(BoapServerConnection* client); BSocket& getSocket(); BSocket& getEventSocket(); BString getHostName(); int getConnectionsNumber(); // Override functions virtual BoapServerConnection* newConnection(int fd, BSocketAddressINET address);

6ae0d525

private: void* function(); int othreaded; int oisBoapns; Boapns::Boapns* oboapns; BList<BoapServerConnection*> oclients;

57456599

BEvent1Int oclientGoneEvent;

6ae0d525

BList<BoapServiceEntry> oservices; BPoll opoll; BSocket onet; BSocket onetEvent; BSocketAddressINET onetEventAddress; BString ohostName;

57456599

public: BUInt64 onumOperations;

6ae0d525

}; /******************************************************************************* * Base for all Server Objects ******************************************************************************* */ class BoapServiceObject; typedef BError (BoapServiceObject::*BoapFunc)(BoapServerConnection* conn, BoapPacket& rx, BoapPacket& tx); class BoapFuncEntry { public: BoapFuncEntry(int cmd, BoapFunc func);

57456599

BUInt32 ocmd;

6ae0d525

BoapFunc ofunc; }; class BoapServiceObject { public: BoapServiceObject(BoapServer& server, BString name = ""); virtual ~BoapServiceObject(); BError setName(BString name);

57456599

BError sendEvent(BString signalName, BInt32 arg); virtual BError processEvent(BString objectName, BString name, BInt32 arg);

6ae0d525

BString name(); BError doPing(BoapServerConnection* conn, BoapPacket& rx, BoapPacket& tx); BError doConnectionPriority(BoapServerConnection* conn, BoapPacket& rx, BoapPacket& tx); BError process(BoapServerConnection* conn, BoapPacket& rx, BoapPacket& tx); virtual BError processEvent(BoapPacket& rx); protected: BError sendEvent(BoapPacket& tx); BoapServer& oserver; BString oname; BUInt32 oapiVersion; BList<BoapFuncEntry> ofuncList; }; #endif