FairMQ  1.4.33
C++ Message Queuing Library and Framework
FairMQSocket.h
1 /********************************************************************************
2  * Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
3  * *
4  * This software is distributed under the terms of the *
5  * GNU Lesser General Public Licence (LGPL) version 3, *
6  * copied verbatim in the file "LICENSE" *
7  ********************************************************************************/
8 
9 #ifndef FAIRMQSOCKET_H_
10 #define FAIRMQSOCKET_H_
11 
12 #include "FairMQMessage.h"
13 
14 #include <memory>
15 #include <ostream>
16 #include <stdexcept>
17 #include <string>
18 #include <vector>
19 
20 class FairMQTransportFactory;
21 
22 namespace fair::mq
23 {
24 
25 enum class TransferCode : int
26 {
27  success = 0,
28  error = -1,
29  timeout = -2,
30  interrupted = -3
31 };
32 
33 } // namespace fair::mq
34 
35 class FairMQSocket
36 {
37  public:
38  FairMQSocket() {}
39  FairMQSocket(FairMQTransportFactory* fac) : fTransport(fac) {}
40 
41  virtual std::string GetId() const = 0;
42 
43  virtual bool Bind(const std::string& address) = 0;
44  virtual bool Connect(const std::string& address) = 0;
45 
46  virtual int64_t Send(FairMQMessagePtr& msg, int timeout = -1) = 0;
47  virtual int64_t Receive(FairMQMessagePtr& msg, int timeout = -1) = 0;
48  virtual int64_t Send(std::vector<std::unique_ptr<FairMQMessage>>& msgVec, int timeout = -1) = 0;
49  virtual int64_t Receive(std::vector<std::unique_ptr<FairMQMessage>>& msgVec, int timeout = -1) = 0;
50 
51  virtual void Close() = 0;
52 
53  virtual void SetOption(const std::string& option, const void* value, size_t valueSize) = 0;
54  virtual void GetOption(const std::string& option, void* value, size_t* valueSize) = 0;
55 
59  virtual void Events(uint32_t* events) = 0;
60  virtual void SetLinger(const int value) = 0;
61  virtual int GetLinger() const = 0;
62  virtual void SetSndBufSize(const int value) = 0;
63  virtual int GetSndBufSize() const = 0;
64  virtual void SetRcvBufSize(const int value) = 0;
65  virtual int GetRcvBufSize() const = 0;
66  virtual void SetSndKernelSize(const int value) = 0;
67  virtual int GetSndKernelSize() const = 0;
68  virtual void SetRcvKernelSize(const int value) = 0;
69  virtual int GetRcvKernelSize() const = 0;
70 
71  virtual unsigned long GetBytesTx() const = 0;
72  virtual unsigned long GetBytesRx() const = 0;
73  virtual unsigned long GetMessagesTx() const = 0;
74  virtual unsigned long GetMessagesRx() const = 0;
75 
76  FairMQTransportFactory* GetTransport() { return fTransport; }
77  void SetTransport(FairMQTransportFactory* transport) { fTransport = transport; }
78 
79  virtual ~FairMQSocket() {};
80 
81  private:
82  FairMQTransportFactory* fTransport{nullptr};
83 };
84 
85 using FairMQSocketPtr = std::unique_ptr<FairMQSocket>;
86 
87 namespace fair::mq
88 {
89 
90 using Socket = FairMQSocket;
91 using SocketPtr = FairMQSocketPtr;
92 struct SocketError : std::runtime_error { using std::runtime_error::runtime_error; };
93 
94 } // namespace fair::mq
95 
96 #endif /* FAIRMQSOCKET_H_ */
FairMQSocket
Definition: FairMQSocket.h:36
fair::mq
Tools for interfacing containers to the transport via polymorphic allocators.
Definition: DeviceRunner.h:23
fair::mq::SocketError
Definition: FairMQSocket.h:92
FairMQSocket::Events
virtual void Events(uint32_t *events)=0
FairMQTransportFactory
Definition: FairMQTransportFactory.h:30

privacy