mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-12 16:21:13 +00:00
3be2f297f3
* CreateSocket factory no longer accepts id param, but the
TransportFactory has an id member instead
124 lines
4.8 KiB
C++
124 lines
4.8 KiB
C++
/********************************************************************************
|
|
* Copyright (C) 2014-2017 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 FAIRMQTRANSPORTFACTORY_H_
|
|
#define FAIRMQTRANSPORTFACTORY_H_
|
|
|
|
#include "FairMQMessage.h"
|
|
#include "FairMQSocket.h"
|
|
#include "FairMQPoller.h"
|
|
#include "FairMQLogger.h"
|
|
#include "FairMQTransports.h"
|
|
#include <string>
|
|
#include <memory>
|
|
#include <vector>
|
|
#include <unordered_map>
|
|
|
|
class FairMQChannel;
|
|
class FairMQProgOptions;
|
|
|
|
class FairMQTransportFactory
|
|
{
|
|
private:
|
|
/// Topology wide unique id
|
|
const std::string fkId;
|
|
|
|
public:
|
|
/// ctor
|
|
/// @param id Topology wide unique id, usually the device id.
|
|
FairMQTransportFactory(const std::string& id);
|
|
|
|
auto GetId() const -> const std::string { return fkId; };
|
|
|
|
/// Initialize transport
|
|
virtual void Initialize(const FairMQProgOptions* config) = 0;
|
|
|
|
/// @brief Create empty FairMQMessage
|
|
/// @return pointer to FairMQMessage
|
|
virtual FairMQMessagePtr CreateMessage() const = 0;
|
|
/// @brief Create new FairMQMessage of specified size
|
|
/// @param size message size
|
|
/// @return pointer to FairMQMessage
|
|
virtual FairMQMessagePtr CreateMessage(const size_t size) const = 0;
|
|
/// @brief Create new FairMQMessage with user provided buffer and size
|
|
/// @param data pointer to user provided buffer
|
|
/// @param size size of the user provided buffer
|
|
/// @param ffn callback, called when the message is transfered (and can be deleted)
|
|
/// @param obj optional helper pointer that can be used in the callback
|
|
/// @return pointer to FairMQMessage
|
|
virtual FairMQMessagePtr CreateMessage(void* data, const size_t size, fairmq_free_fn* ffn, void* hint = nullptr) const = 0;
|
|
|
|
/// Create a socket
|
|
virtual FairMQSocketPtr CreateSocket(const std::string& type, const std::string& name) const = 0;
|
|
|
|
/// Create a poller for all device channels
|
|
virtual FairMQPollerPtr CreatePoller(const std::vector<FairMQChannel>& channels) const = 0;
|
|
/// Create a poller for all device channels
|
|
virtual FairMQPollerPtr CreatePoller(const std::unordered_map<std::string, std::vector<FairMQChannel>>& channelsMap, const std::vector<std::string>& channelList) const = 0;
|
|
/// Create a poller for two sockets
|
|
virtual FairMQPollerPtr CreatePoller(const FairMQSocket& cmdSocket, const FairMQSocket& dataSocket) const = 0;
|
|
|
|
/// Get transport type
|
|
virtual FairMQ::Transport GetType() const = 0;
|
|
|
|
/// Shutdown transport (stop transfers, get ready for complete shutdown)
|
|
virtual void Shutdown() = 0;
|
|
/// Terminate transport (complete shutdown)
|
|
virtual void Terminate() = 0;
|
|
|
|
virtual ~FairMQTransportFactory() {};
|
|
|
|
static auto CreateTransportFactory(const std::string& type, const std::string& id = "") -> std::shared_ptr<FairMQTransportFactory>;
|
|
|
|
static void FairMQNoCleanup(void* /*data*/, void* /*obj*/)
|
|
{
|
|
}
|
|
|
|
template<typename T>
|
|
static void FairMQSimpleMsgCleanup(void* /*data*/, void* obj)
|
|
{
|
|
delete static_cast<T*>(obj);
|
|
}
|
|
|
|
template<typename T>
|
|
inline FairMQMessagePtr NewSimpleMessage(const T& data) const
|
|
{
|
|
// todo: is_trivially_copyable not available on gcc < 5, workaround?
|
|
// static_assert(std::is_trivially_copyable<T>::value, "The argument type for NewSimpleMessage has to be trivially copyable!");
|
|
T* dataCopy = new T(data);
|
|
return CreateMessage(dataCopy, sizeof(T), FairMQSimpleMsgCleanup<T>, dataCopy);
|
|
}
|
|
|
|
template<std::size_t N>
|
|
inline FairMQMessagePtr NewSimpleMessage(const char(&data)[N]) const
|
|
{
|
|
std::string* msgStr = new std::string(data);
|
|
return CreateMessage(const_cast<char*>(msgStr->c_str()), msgStr->length(), FairMQSimpleMsgCleanup<std::string>, msgStr);
|
|
}
|
|
|
|
inline FairMQMessagePtr NewSimpleMessage(const std::string& str) const
|
|
{
|
|
|
|
std::string* msgStr = new std::string(str);
|
|
return CreateMessage(const_cast<char*>(msgStr->c_str()), msgStr->length(), FairMQSimpleMsgCleanup<std::string>, msgStr);
|
|
}
|
|
|
|
template<typename T>
|
|
inline FairMQMessagePtr NewStaticMessage(const T& data) const
|
|
{
|
|
return CreateMessage(data, sizeof(T), FairMQNoCleanup, nullptr);
|
|
}
|
|
|
|
inline FairMQMessagePtr NewStaticMessage(const std::string& str) const
|
|
{
|
|
return CreateMessage(const_cast<char*>(str.c_str()), str.length(), FairMQNoCleanup, nullptr);
|
|
}
|
|
};
|
|
|
|
#endif /* FAIRMQTRANSPORTFACTORY_H_ */
|