using ChannelMap = std::unordered_map<std::string, std::vector<Channel>>No comment in the header yet.
API
fair::mqnamespace
Memory allocators and interfaces related to managing memory via the trasport layer.
Tools for interfacing containers to the transport via polymorphic allocators.
Namespaces
Classes and structs
AlignmentstructChannelclassWrapper class for Socket and related methods.ChannelResourceclassDeviceclassDeviceErrorStatestructDeviceRunnerclassUtility class to facilitate a convenient top-level device launch/shutdown.ErrorCategorystructEventstructEventManagerclassManages event callbacks from different subscribers.is_transferrablestructMemoryResourceclassMessagestructMessageBadAllocstructMessageErrorstructOngoingTransitionstructParserErrorstructPartsstructPluginclassBase class for FairMQ plugins.PluginManagerclassmanages and owns plugin instancesPluginServicesclassFacilitates communication between devices and plugins.PollerstructPollerErrorstructProgOptionsclassPropertyChangestructPropertyChangeAsStringstructPropertyHelperclassPropertyNotFoundErrorstructRefCountBadAllocstructRegionBlockstructRegionConfigstructRegionInfostructRuntimeErrorstructSocketstructSocketErrorstructStateMachineclassStateQueueclassTransportErrorstructTransportFactoryclassTransportFactoryErrorstructUnmanagedRegionstruct
Enums
ErrorCodeenum classTransferCodeenum classStateenum classTransitionenum classTransportenum classRegionEventenum class
Type aliases
using InputMsgCallback = std::function<bool(MessagePtr&, int)>No comment in the header yet.
using InputMultipartCallback = std::function<bool(Parts&, int)>No comment in the header yet.
typedef MemoryResource FairMQMemoryResourceNo comment in the header yet.
using byte = unsigned charNo comment in the header yet.
using BytePmrAllocator = pmr::polymorphic_allocator<fair::mq::byte>No comment in the header yet.
using FreeFn = void(void*data, void*hint)No comment in the header yet.
using MessagePtr = std::unique_ptr<Message>No comment in the header yet.
using PollerPtr = std::unique_ptr<Poller>No comment in the header yet.
using Property = boost::anyNo comment in the header yet.
using Properties = std::map<std::string, Property>No comment in the header yet.
using SocketPtr = std::unique_ptr<Socket>No comment in the header yet.
using RegionCallback = std::function<void(void*, size_t, void*)>No comment in the header yet.
using RegionBulkCallback = std::function<void(const std::vector<RegionBlock>&)>No comment in the header yet.
using RegionEventCallback = std::function<void(RegionInfo)>No comment in the header yet.
using UnmanagedRegionPtr = std::unique_ptr<UnmanagedRegion>No comment in the header yet.
Functions
std::error_code MakeErrorCode(ErrorCode e)No comment in the header yet.
Properties JSONParser(const string& filename, const string& deviceId)No comment in the header yet.
fair::mq::Properties PtreeParser(
const boost::property_tree::ptree& pt,
const std::string& deviceId
)No comment in the header yet.
template<typename ContainerT>
MessagePtr getMessage(
ContainerT&& container_,
MemoryResource* targetResource = nullptr
)No comment in the header yet.
string GetStateName(const State state)No comment in the header yet.
string GetTransitionName(const Transition transition)No comment in the header yet.
State GetState(const string& state)No comment in the header yet.
Transition GetTransition(const string& transition)No comment in the header yet.
std::ostream& operator<<(std::ostream& os, const State& state)No comment in the header yet.
std::ostream& operator<<(std::ostream& os, const Transition& transition)No comment in the header yet.
Properties SuboptParser(
const std::vector<std::string>& channelConfig,
const std::string& deviceId
)A parser implementation for FairMQ channel properties. The parser handles a comma separated key=value list format by using the getsubopt function of the standard library.
The option key '–channel-config' can be used with the list of key/value pairs like e.g.
--channel-config name=output,type=push,method=bind
The FairMQ option parser defines a 'UserParser' function for different formats. Currently it is strictly parsing channel options, but in general the concept is extensible by renaming UserParser to ChannelPropertyParser and introducing additional parser functions.
std::string TransportName(Transport transport)No comment in the header yet.
Transport TransportType(const std::string& transport)No comment in the header yet.
std::ostream& operator<<(std::ostream& os, const Transport& transport)No comment in the header yet.
auto GetEnabledTransports() -> std::vector< Transport >No comment in the header yet.
std::ostream& operator<<(std::ostream& os, const RegionEvent& event)No comment in the header yet.
Variables
static ErrorCategory ecNo comment in the header yet.
static const std::unordered_map<std::string, Transport> TransportTypes { {"default", Transport::DEFAULT}, {"zeromq", Transport::ZMQ}, {"shmem", Transport::SHM} }No comment in the header yet.
static const std::unordered_map<Transport, std::string> TransportNames { {Transport::DEFAULT, "default"}, {Transport::ZMQ, "zeromq"}, {Transport::SHM, "shmem"} }No comment in the header yet.