FairMQSocket.h

/********************************************************************************
 * Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
 *                                                                              *
 *              This software is distributed under the terms of the             * 
 *              GNU Lesser General Public Licence (LGPL) version 3,             *  
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/

#ifndef FAIRMQSOCKET_H_
#define FAIRMQSOCKET_H_

#include <string>
#include <vector>
#include <memory>

#include "FairMQMessage.h"

class FairMQSocket
{
  public:
    FairMQSocket() {}

    virtual std::string GetId() = 0;

    virtual bool Bind(const std::string& address) = 0;
    virtual void Connect(const std::string& address) = 0;

    virtual int Send(FairMQMessagePtr& msg, int timeout = 0) = 0;
    virtual int Receive(FairMQMessagePtr& msg, int timeout = 0) = 0;
    virtual int64_t Send(std::vector<std::unique_ptr<FairMQMessage>>& msgVec, int timeout = 0) = 0;
    virtual int64_t Receive(std::vector<std::unique_ptr<FairMQMessage>>& msgVec, int timeout = 0) = 0;

    virtual int TrySend(FairMQMessagePtr& msg) = 0;
    virtual int TryReceive(FairMQMessagePtr& msg) = 0;
    virtual int64_t TrySend(std::vector<std::unique_ptr<FairMQMessage>>& msgVec) = 0;
    virtual int64_t TryReceive(std::vector<std::unique_ptr<FairMQMessage>>& msgVec) = 0;

    virtual void* GetSocket() const = 0;
    virtual int GetSocket(int nothing) const = 0;

    virtual void Close() = 0;

    virtual void SetOption(const std::string& option, const void* value, size_t valueSize) = 0;
    virtual void GetOption(const std::string& option, void* value, size_t* valueSize) = 0;

    virtual unsigned long GetBytesTx() const = 0;
    virtual unsigned long GetBytesRx() const = 0;
    virtual unsigned long GetMessagesTx() const = 0;
    virtual unsigned long GetMessagesRx() const = 0;

    virtual bool SetSendTimeout(const int timeout, const std::string& address, const std::string& method) = 0;
    virtual int GetSendTimeout() const = 0;
    virtual bool SetReceiveTimeout(const int timeout, const std::string& address, const std::string& method) = 0;
    virtual int GetReceiveTimeout() const = 0;

    virtual ~FairMQSocket() {};
};

using FairMQSocketPtr = std::unique_ptr<FairMQSocket>;

namespace fair
{
namespace mq
{

using Socket = FairMQSocket;
using SocketPtr = FairMQSocketPtr;
struct SocketError : std::runtime_error { using std::runtime_error::runtime_error; };

} /* namespace mq */
} /* namespace fair */

#endif /* FAIRMQSOCKET_H_ */