diff --git a/latest b/latest index 8185624e..7951ba2f 120000 --- a/latest +++ b/latest @@ -1 +1 @@ -v1.3.9 \ No newline at end of file +v1.4.14 \ No newline at end of file diff --git a/v1.4.14/AsioAsyncOp_8h_source.html b/v1.4.14/AsioAsyncOp_8h_source.html new file mode 100644 index 00000000..1889ff4a --- /dev/null +++ b/v1.4.14/AsioAsyncOp_8h_source.html @@ -0,0 +1,86 @@ + + +
+ + + + +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Parser implementation for key-value subopt format. +More...
+#include <fairmq/SuboptParser.h>
#include <boost/property_tree/ptree.hpp>
#include <cstring>
#include <utility>
+Namespaces | |
fair | |
Tools for interfacing containers to the transport via polymorphic allocators. | |
+Functions | |
+Properties | fair::mq::SuboptParser (const vector< string > &channelConfig, const string &deviceId) |
Parser implementation for key-value subopt format.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
▼Nasio | |
▼Ndetail | |
Cassociated_allocator_impl< T, Allocator, std::enable_if_t< T::AllocatorType > > | Specialize to match our coding conventions |
Cassociated_executor_impl< T, Executor, std::enable_if_t< is_executor< typename T::ExecutorType >::value > > | Specialize to match our coding conventions |
▼Nfair | Tools for interfacing containers to the transport via polymorphic allocators |
▼Nmq | |
►Nfsm | |
►Nhooks | |
►Nofi | |
►Nplugins | |
►Nsdk | |
►Nshmem | |
►Ntools | |
CChannelResource | |
CDeviceErrorState | |
CDeviceRunner | Utility class to facilitate a convenient top-level device launch/shutdown |
CErrorCategory | |
CEvent | |
CEventManager | Manages event callbacks from different subscribers |
CFairMQMemoryResource | |
CMessageError | |
COngoingTransition | |
CParserError | |
CPlugin | Base class for FairMQ plugins |
►CPluginManager | Manages and owns plugin instances |
►CPluginServices | Facilitates communication between devices and plugins |
CPollerError | |
CProgOptions | |
CPropertyChange | |
CPropertyChangeAsString | |
CPropertyHelper | |
CPropertyNotFoundError | |
CSocketError | |
►CStateMachine | |
CStateQueue | |
CTransportFactoryError | |
▼Npmix | |
▼CCommands | |
CHolder | |
Cinfo | |
Cpdata | |
Cproc | |
Crank | |
Cruntime_error | |
Cvalue | |
▼Nstd | |
Chash< fair::mq::Transport > | |
Cis_error_code_enum< fair::mq::ErrorCode > | |
CFairMQBenchmarkSampler | |
▼CFairMQChannel | |
CChannelConfigurationError | |
CFairMQDevice | |
CFairMQMerger | |
CFairMQMessage | |
CFairMQMessageNN | |
CFairMQMessageZMQ | |
CFairMQMultiplier | |
CFairMQParts | FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage, used for sending multi-part messages |
CFairMQPoller | |
CFairMQPollerNN | |
CFairMQPollerZMQ | |
CFairMQProxy | |
CFairMQRegionInfo | |
CFairMQSink | |
CFairMQSocket | |
CFairMQSocketNN | |
CFairMQSocketZMQ | |
CFairMQSplitter | |
CFairMQTransportFactory | |
CFairMQTransportFactoryNN | |
CFairMQTransportFactoryZMQ | |
CFairMQUnmanagedRegion | |
CFairMQUnmanagedRegionNN | |
CFairMQUnmanagedRegionZMQ | |
CLinePrinter | |
CMiniTopo | |
CStateSubscription | |
CTerminalConfig | |
CValInfo |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQBenchmarkSampler, including all inherited members.
+AddChannel(const std::string &name, FairMQChannel &&channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
Bind() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
ConditionalRun() | FairMQDevice | inlineprotectedvirtual |
Connect() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
END enum value (defined in FairMQDevice) | FairMQDevice | |
Error enum value (defined in FairMQDevice) | FairMQDevice | |
ERROR_FOUND enum value (defined in FairMQDevice) | FairMQDevice | |
Event enum name (defined in FairMQDevice) | FairMQDevice | |
EXITING enum value (defined in FairMQDevice) | FairMQDevice | |
FairMQBenchmarkSampler() (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
fChannels | FairMQDevice | |
fConfig | FairMQDevice | |
fId | FairMQDevice | protected |
fInternalConfig | FairMQDevice | |
fMaxIterations (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fMsgCounter (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fMsgRate (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fMsgSize (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fMultipart (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fNumIterations (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fNumParts (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fOutChannelName (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | protected |
fTransportFactory | FairMQDevice | protected |
fTransports | FairMQDevice | protected |
GetChannel(const std::string &channelName, const int index=0) (defined in FairMQDevice) | FairMQDevice | inline |
GetConfig() const | FairMQDevice | inline |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
Init() | FairMQDevice | inlineprotectedvirtual |
INIT_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INIT_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
InitTask() override | FairMQBenchmarkSampler | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
internal_IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
internal_READY enum value (defined in FairMQDevice) | FairMQDevice | |
LogSocketRates() | FairMQDevice | virtual |
NewMessage(Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewMessageFor(const std::string &channel, int index, Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const Ts &... inputs) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const std::vector< FairMQChannel *> &channels) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
OK enum value (defined in FairMQDevice) | FairMQDevice | |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMsgCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMultipartCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
operator=(const FairMQDevice &)=delete | FairMQDevice | |
Pause() __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run (defined in FairMQDevice) | FairMQDevice | protectedvirtual |
PostRun() | FairMQDevice | inlineprotectedvirtual |
PreRun() | FairMQDevice | inlineprotectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
READY enum value (defined in FairMQDevice) | FairMQDevice | |
Receive(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
Receive(FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
RegisterChannelEndpoint(const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) (defined in FairMQDevice) | FairMQDevice | inline |
RegisterChannelEndpoints() (defined in FairMQDevice) | FairMQDevice | inlinevirtual |
RESET_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESET_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
resume (defined in FairMQDevice) | FairMQDevice | protected |
Run() override | FairMQBenchmarkSampler | protectedvirtual |
RUN enum value (defined in FairMQDevice) | FairMQDevice | |
RUNNING enum value (defined in FairMQDevice) | FairMQDevice | |
RunStateMachine() (defined in FairMQDevice) | FairMQDevice | inline |
Send(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Send(FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(fair::mq::ProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitTimeoutInS(int initTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
State enum name (defined in FairMQDevice) | FairMQDevice | |
STOP enum value (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
~FairMQBenchmarkSampler() (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | inlinevirtual |
~FairMQDevice() | FairMQDevice | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <FairMQBenchmarkSampler.h>
+Protected Member Functions | |
+virtual void | InitTask () override |
Task initialization (can be overloaded in child classes) | |
+virtual void | Run () override |
Runs the device (to be overloaded in child classes) | |
![]() | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+virtual void | Bind () |
+virtual void | Connect () |
+virtual void | PreRun () |
Called in the RUNNING state once before executing the Run()/ConditionalRun() method. | |
+virtual bool | ConditionalRun () |
Called during RUNNING state repeatedly until it returns false or device state changes. | |
+virtual void | PostRun () |
Called in the RUNNING state once after executing the Run()/ConditionalRun() method. | |
+virtual void | Pause () __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run |
+Protected Attributes | |
+bool | fMultipart |
+size_t | fNumParts |
+size_t | fMsgSize |
+std::atomic< int > | fMsgCounter |
+float | fMsgRate |
+uint64_t | fNumIterations |
+uint64_t | fMaxIterations |
+std::string | fOutChannelName |
![]() | |
+std::shared_ptr< FairMQTransportFactory > | fTransportFactory |
Default transport factory. | |
+std::unordered_map< fair::mq::Transport, std::shared_ptr< FairMQTransportFactory > > | fTransports |
Container for transports. | |
+std::string | fId |
Device ID. | |
virtual void go to READY with STOP transition and back to RUNNING with RUN to | resume |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +STOP, +RESET_TASK, +RESET_DEVICE, + + internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (fair::mq::ProgOptions &config) |
Constructor with external fair::mq::ProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (fair::mq::ProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external fair::mq::ProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
+template<typename Serializer , typename DataType , typename... Args> | |
void | Serialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
+template<typename Deserializer , typename DataType , typename... Args> | |
void | Deserialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
int | Send (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
+auto | Transport () const -> FairMQTransportFactory * |
Getter for default transport factory. | |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename... Args> | |
FairMQMessagePtr | NewMessageFor (const std::string &channel, int index, Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessageFor (const std::string &channel, int index, const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessageFor (const std::string &channel, int index, const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel *> &channels) |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (fair::mq::ProgOptions &config) |
Assigns config to the device. | |
+fair::mq::ProgOptions * | GetConfig () const |
Get pointer to the config. | |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) |
+void | OnData (const std::string &channelName, InputMsgCallback callback) |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) |
+void | OnData (const std::string &channelName, InputMultipartCallback callback) |
+FairMQChannel & | GetChannel (const std::string &channelName, const int index=0) |
+virtual void | RegisterChannelEndpoints () |
+bool | RegisterChannelEndpoint (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) |
+void | PrintRegisteredChannels () |
+void | SetId (const std::string &id) |
+std::string | GetId () |
+const fair::mq::tools::Version | GetVersion () const |
+void | SetNumIoThreads (int numIoThreads) |
+int | GetNumIoThreads () const |
+void | SetNetworkInterface (const std::string &networkInterface) |
+std::string | GetNetworkInterface () const |
+void | SetDefaultTransport (const std::string &name) |
+std::string | GetDefaultTransport () const |
+void | SetInitTimeoutInS (int initTimeoutInS) |
+int | GetInitTimeoutInS () const |
void | SetTransport (const std::string &transport) |
+std::string | GetTransportName () const |
Gets the default transport name. | |
+void | SetRawCmdLineArgs (const std::vector< std::string > &args) |
+std::vector< std::string > | GetRawCmdLineArgs () const |
+void | RunStateMachine () |
template<typename Rep , typename Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &name, FairMQChannel &&channel) |
![]() | |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< fair::mq::ProgOptions > | fInternalConfig |
Internal program options configuration. | |
+fair::mq::ProgOptions * | fConfig |
Pointer to config (internal or external) | |
Sampler to generate traffic for benchmarking.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQChannel, including all inherited members.
+Bind(const std::string &address) (defined in FairMQChannel) | FairMQChannel | inline |
BindEndpoint(std::string &endpoint) (defined in FairMQChannel) | FairMQChannel | |
Connect(const std::string &address) (defined in FairMQChannel) | FairMQChannel | inline |
ConnectEndpoint(const std::string &endpoint) (defined in FairMQChannel) | FairMQChannel | |
DefaultAddress (defined in FairMQChannel) | FairMQChannel | static |
DefaultAutoBind (defined in FairMQChannel) | FairMQChannel | static |
DefaultLinger (defined in FairMQChannel) | FairMQChannel | static |
DefaultMethod (defined in FairMQChannel) | FairMQChannel | static |
DefaultName (defined in FairMQChannel) | FairMQChannel | static |
DefaultPortRangeMax (defined in FairMQChannel) | FairMQChannel | static |
DefaultPortRangeMin (defined in FairMQChannel) | FairMQChannel | static |
DefaultRateLogging (defined in FairMQChannel) | FairMQChannel | static |
DefaultRcvBufSize (defined in FairMQChannel) | FairMQChannel | static |
DefaultRcvKernelSize (defined in FairMQChannel) | FairMQChannel | static |
DefaultSndBufSize (defined in FairMQChannel) | FairMQChannel | static |
DefaultSndKernelSize (defined in FairMQChannel) | FairMQChannel | static |
DefaultTransportName (defined in FairMQChannel) | FairMQChannel | static |
DefaultTransportType (defined in FairMQChannel) | FairMQChannel | static |
DefaultType (defined in FairMQChannel) | FairMQChannel | static |
FairMQChannel() | FairMQChannel | |
FairMQChannel(const std::string &name) | FairMQChannel | |
FairMQChannel(const std::string &type, const std::string &method, const std::string &address) | FairMQChannel | |
FairMQChannel(const std::string &name, const std::string &type, std::shared_ptr< FairMQTransportFactory > factory) | FairMQChannel | |
FairMQChannel(const std::string &name, const std::string &type, const std::string &method, const std::string &address, std::shared_ptr< FairMQTransportFactory > factory) | FairMQChannel | |
FairMQChannel(const std::string &name, int index, const fair::mq::Properties &properties) (defined in FairMQChannel) | FairMQChannel | |
FairMQChannel(const FairMQChannel &) | FairMQChannel | |
FairMQChannel(const FairMQChannel &, const std::string &name) | FairMQChannel | |
FairMQChannel(FairMQChannel &&)=delete | FairMQChannel | |
FairMQDevice (defined in FairMQChannel) | FairMQChannel | friend |
GetAddress() const | FairMQChannel | |
GetAutoBind() const | FairMQChannel | |
GetBytesRx() const (defined in FairMQChannel) | FairMQChannel | inline |
GetBytesTx() const (defined in FairMQChannel) | FairMQChannel | inline |
GetChannelIndex() const __attribute__((deprecated("Use GetIndex()"))) | FairMQChannel | inline |
GetChannelName() const __attribute__((deprecated("Use GetName()"))) | FairMQChannel | inline |
GetChannelPrefix() const __attribute__((deprecated("Use GetPrefix()"))) | FairMQChannel | inline |
GetIndex() const (defined in FairMQChannel) | FairMQChannel | |
GetLinger() const | FairMQChannel | |
GetMessagesRx() const (defined in FairMQChannel) | FairMQChannel | inline |
GetMessagesTx() const (defined in FairMQChannel) | FairMQChannel | inline |
GetMethod() const | FairMQChannel | |
GetName() const (defined in FairMQChannel) | FairMQChannel | |
GetPortRangeMax() const | FairMQChannel | |
GetPortRangeMin() const | FairMQChannel | |
GetPrefix() const (defined in FairMQChannel) | FairMQChannel | |
GetRateLogging() const | FairMQChannel | |
GetRcvBufSize() const | FairMQChannel | |
GetRcvKernelSize() const | FairMQChannel | |
GetSndBufSize() const | FairMQChannel | |
GetSndKernelSize() const | FairMQChannel | |
GetSocket() const (defined in FairMQChannel) | FairMQChannel | |
GetTransportName() const | FairMQChannel | |
GetTransportType() const | FairMQChannel | |
GetType() const | FairMQChannel | |
Init() (defined in FairMQChannel) | FairMQChannel | |
IsValid() const | FairMQChannel | |
NewMessage(Args &&... args) (defined in FairMQChannel) | FairMQChannel | inline |
NewSimpleMessage(const T &data) (defined in FairMQChannel) | FairMQChannel | inline |
NewStaticMessage(const T &data) (defined in FairMQChannel) | FairMQChannel | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQChannel) | FairMQChannel | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQChannel) | FairMQChannel | inline |
operator=(const FairMQChannel &) | FairMQChannel | |
operator=(FairMQChannel &&)=delete | FairMQChannel | |
Receive(FairMQMessagePtr &msg, int rcvTimeoutInMs=-1) | FairMQChannel | inline |
Receive(std::vector< FairMQMessagePtr > &msgVec, int rcvTimeoutInMs=-1) | FairMQChannel | inline |
Receive(FairMQParts &parts, int rcvTimeoutInMs=-1) | FairMQChannel | inline |
ResetChannel() | FairMQChannel | |
Send(FairMQMessagePtr &msg, int sndTimeoutInMs=-1) | FairMQChannel | inline |
Send(std::vector< FairMQMessagePtr > &msgVec, int sndTimeoutInMs=-1) | FairMQChannel | inline |
Send(FairMQParts &parts, int sndTimeoutInMs=-1) | FairMQChannel | inline |
Transport() -> FairMQTransportFactory * (defined in FairMQChannel) | FairMQChannel | inline |
UpdateAddress(const std::string &address) | FairMQChannel | |
UpdateAutoBind(const bool autobind) | FairMQChannel | |
UpdateChannelName(const std::string &name) __attribute__((deprecated("Use UpdateName()"))) | FairMQChannel | inline |
UpdateLinger(const int duration) | FairMQChannel | |
UpdateMethod(const std::string &method) | FairMQChannel | |
UpdateName(const std::string &name) (defined in FairMQChannel) | FairMQChannel | |
UpdatePortRangeMax(const int maxPort) | FairMQChannel | |
UpdatePortRangeMin(const int minPort) | FairMQChannel | |
UpdateRateLogging(const int rateLogging) | FairMQChannel | |
UpdateRcvBufSize(const int rcvBufSize) | FairMQChannel | |
UpdateRcvKernelSize(const int rcvKernelSize) | FairMQChannel | |
UpdateSndBufSize(const int sndBufSize) | FairMQChannel | |
UpdateSndKernelSize(const int sndKernelSize) | FairMQChannel | |
UpdateTransport(const std::string &transport) | FairMQChannel | |
UpdateType(const std::string &type) | FairMQChannel | |
Validate() | FairMQChannel | |
ValidateChannel() __attribute__((deprecated("Use Validate()"))) | FairMQChannel | inline |
~FairMQChannel() | FairMQChannel | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Classes | |
struct | ChannelConfigurationError |
+Public Member Functions | |
+ | FairMQChannel () |
Default constructor. | |
FairMQChannel (const std::string &name) | |
FairMQChannel (const std::string &type, const std::string &method, const std::string &address) | |
FairMQChannel (const std::string &name, const std::string &type, std::shared_ptr< FairMQTransportFactory > factory) | |
FairMQChannel (const std::string &name, const std::string &type, const std::string &method, const std::string &address, std::shared_ptr< FairMQTransportFactory > factory) | |
+ | FairMQChannel (const std::string &name, int index, const fair::mq::Properties &properties) |
+ | FairMQChannel (const FairMQChannel &) |
Copy Constructor. | |
+ | FairMQChannel (const FairMQChannel &, const std::string &name) |
Copy Constructor (with new name) | |
+ | FairMQChannel (FairMQChannel &&)=delete |
Move constructor. | |
+FairMQChannel & | operator= (const FairMQChannel &) |
Assignment operator. | |
+FairMQChannel & | operator= (FairMQChannel &&)=delete |
Move assignment operator. | |
+virtual | ~FairMQChannel () |
Destructor. | |
+FairMQSocket & | GetSocket () const |
+bool | Bind (const std::string &address) |
+bool | Connect (const std::string &address) |
std::string | GetChannelName () const __attribute__((deprecated("Use GetName()"))) |
+std::string | GetName () const |
std::string | GetChannelPrefix () const __attribute__((deprecated("Use GetPrefix()"))) |
+std::string | GetPrefix () const |
std::string | GetChannelIndex () const __attribute__((deprecated("Use GetIndex()"))) |
+std::string | GetIndex () const |
std::string | GetType () const |
std::string | GetMethod () const |
std::string | GetAddress () const |
std::string | GetTransportName () const |
fair::mq::Transport | GetTransportType () const |
int | GetSndBufSize () const |
int | GetRcvBufSize () const |
int | GetSndKernelSize () const |
int | GetRcvKernelSize () const |
int | GetLinger () const |
int | GetRateLogging () const |
int | GetPortRangeMin () const |
int | GetPortRangeMax () const |
bool | GetAutoBind () const |
void | UpdateType (const std::string &type) |
void | UpdateMethod (const std::string &method) |
void | UpdateAddress (const std::string &address) |
void | UpdateTransport (const std::string &transport) |
void | UpdateSndBufSize (const int sndBufSize) |
void | UpdateRcvBufSize (const int rcvBufSize) |
void | UpdateSndKernelSize (const int sndKernelSize) |
void | UpdateRcvKernelSize (const int rcvKernelSize) |
void | UpdateLinger (const int duration) |
void | UpdateRateLogging (const int rateLogging) |
void | UpdatePortRangeMin (const int minPort) |
void | UpdatePortRangeMax (const int maxPort) |
void | UpdateAutoBind (const bool autobind) |
void | UpdateChannelName (const std::string &name) __attribute__((deprecated("Use UpdateName()"))) |
+void | UpdateName (const std::string &name) |
bool | IsValid () const |
bool | ValidateChannel () __attribute__((deprecated("Use Validate()"))) |
bool | Validate () |
+void | Init () |
+bool | ConnectEndpoint (const std::string &endpoint) |
+bool | BindEndpoint (std::string &endpoint) |
+void | ResetChannel () |
Resets the channel (requires validation to be used again). | |
int | Send (FairMQMessagePtr &msg, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, int rcvTimeoutInMs=-1) |
int64_t | Send (std::vector< FairMQMessagePtr > &msgVec, int sndTimeoutInMs=-1) |
int64_t | Receive (std::vector< FairMQMessagePtr > &msgVec, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, int rcvTimeoutInMs=-1) |
+unsigned long | GetBytesTx () const |
+unsigned long | GetBytesRx () const |
+unsigned long | GetMessagesTx () const |
+unsigned long | GetMessagesRx () const |
+auto | Transport () -> FairMQTransportFactory * |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+Friends | |
+class | FairMQDevice |
FairMQChannel::FairMQChannel | +( | +const std::string & | +name | ) | ++ |
Constructor
name | Channel name |
FairMQChannel::FairMQChannel | +( | +const std::string & | +type, | +
+ | + | const std::string & | +method, | +
+ | + | const std::string & | +address | +
+ | ) | ++ |
Constructor
type | Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) |
method | Socket method (bind/connect) |
address | Network address to bind/connect to (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") |
FairMQChannel::FairMQChannel | +( | +const std::string & | +name, | +
+ | + | const std::string & | +type, | +
+ | + | std::shared_ptr< FairMQTransportFactory > | +factory | +
+ | ) | ++ |
Constructor
name | Channel name |
type | Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) |
factory | TransportFactory |
FairMQChannel::FairMQChannel | +( | +const std::string & | +name, | +
+ | + | const std::string & | +type, | +
+ | + | const std::string & | +method, | +
+ | + | const std::string & | +address, | +
+ | + | std::shared_ptr< FairMQTransportFactory > | +factory | +
+ | ) | ++ |
Constructor
name | Channel name |
type | Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) |
method | Socket method (bind/connect) |
address | Network address to bind/connect to (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") |
factory | TransportFactory |
string FairMQChannel::GetAddress | +( | +) | +const | +
Get socket address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc")
bool FairMQChannel::GetAutoBind | +( | +) | +const | +
Set automatic binding (pick random port if bind fails)
+
|
+ +inline | +
Get channel index
+
|
+ +inline | +
Get channel name
+
|
+ +inline | +
Get channel prefix
int FairMQChannel::GetLinger | +( | +) | +const | +
Get linger duration (in milliseconds)
string FairMQChannel::GetMethod | +( | +) | +const | +
Get socket method
int FairMQChannel::GetPortRangeMax | +( | +) | +const | +
Get end of the port range for automatic binding
int FairMQChannel::GetPortRangeMin | +( | +) | +const | +
Get start of the port range for automatic binding
int FairMQChannel::GetRateLogging | +( | +) | +const | +
Get socket rate logging interval (in seconds)
int FairMQChannel::GetRcvBufSize | +( | +) | +const | +
Get socket receive buffer size (in number of messages)
int FairMQChannel::GetRcvKernelSize | +( | +) | +const | +
Get socket kernel transmit receive buffer size (in bytes)
int FairMQChannel::GetSndBufSize | +( | +) | +const | +
Get socket send buffer size (in number of messages)
int FairMQChannel::GetSndKernelSize | +( | +) | +const | +
Get socket kernel transmit send buffer size (in bytes)
string FairMQChannel::GetTransportName | +( | +) | +const | +
Get channel transport name ("default", "zeromq", "nanomsg" or "shmem")
Transport FairMQChannel::GetTransportType | +( | +) | +const | +
Get channel transport type
string FairMQChannel::GetType | +( | +) | +const | +
Get socket type
bool FairMQChannel::IsValid | +( | +) | +const | +
Checks if the configured channel settings are valid (checks the validity parameter, without running full validation (as oposed to ValidateChannel()))
+
|
+ +inline | +
Receives a message from the socket queue.
msg | Constant reference of unique_ptr to a FairMQMessage |
rcvTimeoutInMs | receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) |
+
|
+ +inline | +
Receive a vector of messages
msgVec | message vector reference |
rcvTimeoutInMs | receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) |
+
|
+ +inline | +
Receive FairMQParts
parts | FairMQParts reference |
rcvTimeoutInMs | receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) |
+
|
+ +inline | +
Sends a message to the socket queue.
msg | Constant reference of unique_ptr to a FairMQMessage |
sndTimeoutInMs | send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) |
+
|
+ +inline | +
Send a vector of messages
msgVec | message vector reference |
sndTimeoutInMs | send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) |
+
|
+ +inline | +
Send FairMQParts
parts | FairMQParts reference |
sndTimeoutInMs | send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) |
void FairMQChannel::UpdateAddress | +( | +const std::string & | +address | ) | ++ |
Set socket address
Socket | address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") |
void FairMQChannel::UpdateAutoBind | +( | +const bool | +autobind | ) | ++ |
Set automatic binding (pick random port if bind fails)
autobind | true/false, true to enable automatic binding |
+
|
+ +inline | +
Set channel name
name | Arbitrary channel name |
void FairMQChannel::UpdateLinger | +( | +const int | +duration | ) | ++ |
Set linger duration (in milliseconds)
duration | linger duration (in milliseconds) |
void FairMQChannel::UpdateMethod | +( | +const std::string & | +method | ) | ++ |
Set socket method
method | Socket method (bind/connect) |
void FairMQChannel::UpdatePortRangeMax | +( | +const int | +maxPort | ) | ++ |
Set end of the port range for automatic binding
maxPort | end of the port range |
void FairMQChannel::UpdatePortRangeMin | +( | +const int | +minPort | ) | ++ |
Set start of the port range for automatic binding
minPort | start of the port range |
void FairMQChannel::UpdateRateLogging | +( | +const int | +rateLogging | ) | ++ |
Set socket rate logging interval (in seconds)
rateLogging | Socket rate logging interval (in seconds) |
void FairMQChannel::UpdateRcvBufSize | +( | +const int | +rcvBufSize | ) | ++ |
Set socket receive buffer size
rcvBufSize | Socket receive buffer size (in number of messages) |
void FairMQChannel::UpdateRcvKernelSize | +( | +const int | +rcvKernelSize | ) | ++ |
Set socket kernel transmit receive buffer size (in bytes)
rcvKernelSize | Socket receive buffer size (in bytes) |
void FairMQChannel::UpdateSndBufSize | +( | +const int | +sndBufSize | ) | ++ |
Set socket send buffer size
sndBufSize | Socket send buffer size (in number of messages) |
void FairMQChannel::UpdateSndKernelSize | +( | +const int | +sndKernelSize | ) | ++ |
Set socket kernel transmit send buffer size (in bytes)
sndKernelSize | Socket send buffer size (in bytes) |
void FairMQChannel::UpdateTransport | +( | +const std::string & | +transport | ) | ++ |
Set channel transport
transport | transport string ("default", "zeromq", "nanomsg" or "shmem") |
void FairMQChannel::UpdateType | +( | +const std::string & | +type | ) | ++ |
Set socket type
type | Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) |
bool FairMQChannel::Validate | +( | +) | ++ |
Validates channel configuration
+
|
+ +inline | +
Validates channel configuration
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQDevice, including all inherited members.
+AddChannel(const std::string &name, FairMQChannel &&channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
Bind() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
ConditionalRun() | FairMQDevice | inlineprotectedvirtual |
Connect() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
END enum value (defined in FairMQDevice) | FairMQDevice | |
Error enum value (defined in FairMQDevice) | FairMQDevice | |
ERROR_FOUND enum value (defined in FairMQDevice) | FairMQDevice | |
Event enum name (defined in FairMQDevice) | FairMQDevice | |
EXITING enum value (defined in FairMQDevice) | FairMQDevice | |
FairMQChannel (defined in FairMQDevice) | FairMQDevice | friend |
FairMQDevice() | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
fChannels | FairMQDevice | |
fConfig | FairMQDevice | |
fId | FairMQDevice | protected |
fInternalConfig | FairMQDevice | |
fTransportFactory | FairMQDevice | protected |
fTransports | FairMQDevice | protected |
GetChannel(const std::string &channelName, const int index=0) (defined in FairMQDevice) | FairMQDevice | inline |
GetConfig() const | FairMQDevice | inline |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
Init() | FairMQDevice | inlineprotectedvirtual |
INIT_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INIT_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
InitTask() | FairMQDevice | inlineprotectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
internal_IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
internal_READY enum value (defined in FairMQDevice) | FairMQDevice | |
LogSocketRates() | FairMQDevice | virtual |
NewMessage(Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewMessageFor(const std::string &channel, int index, Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const Ts &... inputs) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const std::vector< FairMQChannel *> &channels) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
OK enum value (defined in FairMQDevice) | FairMQDevice | |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMsgCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMultipartCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
operator=(const FairMQDevice &)=delete | FairMQDevice | |
Pause() __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run (defined in FairMQDevice) | FairMQDevice | protectedvirtual |
PostRun() | FairMQDevice | inlineprotectedvirtual |
PreRun() | FairMQDevice | inlineprotectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
READY enum value (defined in FairMQDevice) | FairMQDevice | |
Receive(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
Receive(FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
RegisterChannelEndpoint(const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) (defined in FairMQDevice) | FairMQDevice | inline |
RegisterChannelEndpoints() (defined in FairMQDevice) | FairMQDevice | inlinevirtual |
RESET_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESET_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
resume (defined in FairMQDevice) | FairMQDevice | protected |
Run() | FairMQDevice | inlineprotectedvirtual |
RUN enum value (defined in FairMQDevice) | FairMQDevice | |
RUNNING enum value (defined in FairMQDevice) | FairMQDevice | |
RunStateMachine() (defined in FairMQDevice) | FairMQDevice | inline |
Send(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Send(FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(fair::mq::ProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitTimeoutInS(int initTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
State enum name (defined in FairMQDevice) | FairMQDevice | |
STOP enum value (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (fair::mq::ProgOptions &config) |
Constructor with external fair::mq::ProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (fair::mq::ProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external fair::mq::ProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
+template<typename Serializer , typename DataType , typename... Args> | |
void | Serialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
+template<typename Deserializer , typename DataType , typename... Args> | |
void | Deserialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
int | Send (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
+auto | Transport () const -> FairMQTransportFactory * |
Getter for default transport factory. | |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename... Args> | |
FairMQMessagePtr | NewMessageFor (const std::string &channel, int index, Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessageFor (const std::string &channel, int index, const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessageFor (const std::string &channel, int index, const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel *> &channels) |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (fair::mq::ProgOptions &config) |
Assigns config to the device. | |
+fair::mq::ProgOptions * | GetConfig () const |
Get pointer to the config. | |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) |
+void | OnData (const std::string &channelName, InputMsgCallback callback) |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) |
+void | OnData (const std::string &channelName, InputMultipartCallback callback) |
+FairMQChannel & | GetChannel (const std::string &channelName, const int index=0) |
+virtual void | RegisterChannelEndpoints () |
+bool | RegisterChannelEndpoint (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) |
+void | PrintRegisteredChannels () |
+void | SetId (const std::string &id) |
+std::string | GetId () |
+const fair::mq::tools::Version | GetVersion () const |
+void | SetNumIoThreads (int numIoThreads) |
+int | GetNumIoThreads () const |
+void | SetNetworkInterface (const std::string &networkInterface) |
+std::string | GetNetworkInterface () const |
+void | SetDefaultTransport (const std::string &name) |
+std::string | GetDefaultTransport () const |
+void | SetInitTimeoutInS (int initTimeoutInS) |
+int | GetInitTimeoutInS () const |
void | SetTransport (const std::string &transport) |
+std::string | GetTransportName () const |
Gets the default transport name. | |
+void | SetRawCmdLineArgs (const std::vector< std::string > &args) |
+std::vector< std::string > | GetRawCmdLineArgs () const |
+void | RunStateMachine () |
template<typename Rep , typename Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &name, FairMQChannel &&channel) |
+Public Attributes | |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< fair::mq::ProgOptions > | fInternalConfig |
Internal program options configuration. | |
+fair::mq::ProgOptions * | fConfig |
Pointer to config (internal or external) | |
+Protected Member Functions | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+virtual void | Bind () |
+virtual void | Connect () |
+virtual void | InitTask () |
Task initialization (can be overloaded in child classes) | |
+virtual void | Run () |
Runs the device (to be overloaded in child classes) | |
+virtual void | PreRun () |
Called in the RUNNING state once before executing the Run()/ConditionalRun() method. | |
+virtual bool | ConditionalRun () |
Called during RUNNING state repeatedly until it returns false or device state changes. | |
+virtual void | PostRun () |
Called in the RUNNING state once after executing the Run()/ConditionalRun() method. | |
+virtual void | Pause () __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run |
+Protected Attributes | |
+std::shared_ptr< FairMQTransportFactory > | fTransportFactory |
Default transport factory. | |
+std::unordered_map< fair::mq::Transport, std::shared_ptr< FairMQTransportFactory > > | fTransports |
Container for transports. | |
+std::string | fId |
Device ID. | |
virtual void go to READY with STOP transition and back to RUNNING with RUN to | resume |
+Friends | |
+class | FairMQChannel |
shared_ptr< FairMQTransportFactory > FairMQDevice::AddTransport | +( | +const fair::mq::Transport | +transport | ) | ++ |
Adds a transport to the device if it doesn't exist
transport | Transport string ("zeromq"/"nanomsg"/"shmem") |
+
|
+ +inline | +
Shorthand method to receive msg
on chan
at index i
msg | message reference |
chan | channel name |
i | channel index |
rcvTimeoutInMs | receive timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) |
+
|
+ +inline | +
Shorthand method to receive FairMQParts on chan
at index i
parts | parts reference |
chan | channel name |
i | channel index |
rcvTimeoutInMs | receive timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) |
+
|
+ +inline | +
Shorthand method to send msg
on chan
at index i
msg | message reference |
chan | channel name |
i | channel index |
sndTimeoutInMs | send timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) |
+
|
+ +inline | +
Shorthand method to send FairMQParts on chan
at index i
parts | parts reference |
chan | channel name |
i | channel index |
sndTimeoutInMs | send timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) |
+
|
+ +inline | +
Sets the default transport for the device
transport | Transport string ("zeromq"/"nanomsg"/"shmem") |
+
|
+ +inline | +
Wait for the supplied amount of time or for interruption. If interrupted, returns false, otherwise true.
duration | wait duration |
+
|
+ +protected | +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQMerger, including all inherited members.
+AddChannel(const std::string &name, FairMQChannel &&channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
Bind() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
ConditionalRun() | FairMQDevice | inlineprotectedvirtual |
Connect() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
END enum value (defined in FairMQDevice) | FairMQDevice | |
Error enum value (defined in FairMQDevice) | FairMQDevice | |
ERROR_FOUND enum value (defined in FairMQDevice) | FairMQDevice | |
Event enum name (defined in FairMQDevice) | FairMQDevice | |
EXITING enum value (defined in FairMQDevice) | FairMQDevice | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQMerger() (defined in FairMQMerger) | FairMQMerger | |
fChannels | FairMQDevice | |
fConfig | FairMQDevice | |
fId | FairMQDevice | protected |
fInChannelName (defined in FairMQMerger) | FairMQMerger | protected |
fInternalConfig | FairMQDevice | |
fMultipart (defined in FairMQMerger) | FairMQMerger | protected |
fOutChannelName (defined in FairMQMerger) | FairMQMerger | protected |
fTransportFactory | FairMQDevice | protected |
fTransports | FairMQDevice | protected |
GetChannel(const std::string &channelName, const int index=0) (defined in FairMQDevice) | FairMQDevice | inline |
GetConfig() const | FairMQDevice | inline |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
Init() | FairMQDevice | inlineprotectedvirtual |
INIT_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INIT_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
InitTask() override | FairMQMerger | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
internal_IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
internal_READY enum value (defined in FairMQDevice) | FairMQDevice | |
LogSocketRates() | FairMQDevice | virtual |
NewMessage(Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewMessageFor(const std::string &channel, int index, Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const Ts &... inputs) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const std::vector< FairMQChannel *> &channels) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
OK enum value (defined in FairMQDevice) | FairMQDevice | |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMsgCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMultipartCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
operator=(const FairMQDevice &)=delete | FairMQDevice | |
Pause() __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run (defined in FairMQDevice) | FairMQDevice | protectedvirtual |
PostRun() | FairMQDevice | inlineprotectedvirtual |
PreRun() | FairMQDevice | inlineprotectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
READY enum value (defined in FairMQDevice) | FairMQDevice | |
Receive(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
Receive(FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
RegisterChannelEndpoint(const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) (defined in FairMQDevice) | FairMQDevice | inline |
RegisterChannelEndpoints() override (defined in FairMQMerger) | FairMQMerger | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESET_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
resume (defined in FairMQDevice) | FairMQDevice | protected |
Run() override | FairMQMerger | protectedvirtual |
RUN enum value (defined in FairMQDevice) | FairMQDevice | |
RUNNING enum value (defined in FairMQDevice) | FairMQDevice | |
RunStateMachine() (defined in FairMQDevice) | FairMQDevice | inline |
Send(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Send(FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(fair::mq::ProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitTimeoutInS(int initTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
State enum name (defined in FairMQDevice) | FairMQDevice | |
STOP enum value (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQMerger() (defined in FairMQMerger) | FairMQMerger | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <FairMQMerger.h>
+Protected Member Functions | |
+virtual void | RegisterChannelEndpoints () override |
+virtual void | Run () override |
Runs the device (to be overloaded in child classes) | |
+virtual void | InitTask () override |
Task initialization (can be overloaded in child classes) | |
![]() | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+virtual void | Bind () |
+virtual void | Connect () |
+virtual void | PreRun () |
Called in the RUNNING state once before executing the Run()/ConditionalRun() method. | |
+virtual bool | ConditionalRun () |
Called during RUNNING state repeatedly until it returns false or device state changes. | |
+virtual void | PostRun () |
Called in the RUNNING state once after executing the Run()/ConditionalRun() method. | |
+virtual void | Pause () __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run |
+Protected Attributes | |
+bool | fMultipart |
+std::string | fInChannelName |
+std::string | fOutChannelName |
![]() | |
+std::shared_ptr< FairMQTransportFactory > | fTransportFactory |
Default transport factory. | |
+std::unordered_map< fair::mq::Transport, std::shared_ptr< FairMQTransportFactory > > | fTransports |
Container for transports. | |
+std::string | fId |
Device ID. | |
virtual void go to READY with STOP transition and back to RUNNING with RUN to | resume |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +STOP, +RESET_TASK, +RESET_DEVICE, + + internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (fair::mq::ProgOptions &config) |
Constructor with external fair::mq::ProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (fair::mq::ProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external fair::mq::ProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
+template<typename Serializer , typename DataType , typename... Args> | |
void | Serialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
+template<typename Deserializer , typename DataType , typename... Args> | |
void | Deserialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
int | Send (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
+auto | Transport () const -> FairMQTransportFactory * |
Getter for default transport factory. | |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename... Args> | |
FairMQMessagePtr | NewMessageFor (const std::string &channel, int index, Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessageFor (const std::string &channel, int index, const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessageFor (const std::string &channel, int index, const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel *> &channels) |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (fair::mq::ProgOptions &config) |
Assigns config to the device. | |
+fair::mq::ProgOptions * | GetConfig () const |
Get pointer to the config. | |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) |
+void | OnData (const std::string &channelName, InputMsgCallback callback) |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) |
+void | OnData (const std::string &channelName, InputMultipartCallback callback) |
+FairMQChannel & | GetChannel (const std::string &channelName, const int index=0) |
+bool | RegisterChannelEndpoint (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) |
+void | PrintRegisteredChannels () |
+void | SetId (const std::string &id) |
+std::string | GetId () |
+const fair::mq::tools::Version | GetVersion () const |
+void | SetNumIoThreads (int numIoThreads) |
+int | GetNumIoThreads () const |
+void | SetNetworkInterface (const std::string &networkInterface) |
+std::string | GetNetworkInterface () const |
+void | SetDefaultTransport (const std::string &name) |
+std::string | GetDefaultTransport () const |
+void | SetInitTimeoutInS (int initTimeoutInS) |
+int | GetInitTimeoutInS () const |
void | SetTransport (const std::string &transport) |
+std::string | GetTransportName () const |
Gets the default transport name. | |
+void | SetRawCmdLineArgs (const std::vector< std::string > &args) |
+std::vector< std::string > | GetRawCmdLineArgs () const |
+void | RunStateMachine () |
template<typename Rep , typename Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &name, FairMQChannel &&channel) |
![]() | |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< fair::mq::ProgOptions > | fInternalConfig |
Internal program options configuration. | |
+fair::mq::ProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQMessage, including all inherited members.
+Copy(const FairMQMessage &msg)=0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
FairMQMessage()=default (defined in FairMQMessage) | FairMQMessage | |
FairMQMessage(FairMQTransportFactory *factory) (defined in FairMQMessage) | FairMQMessage | inline |
GetData() const =0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
GetSize() const =0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
GetTransport() (defined in FairMQMessage) | FairMQMessage | inline |
GetType() const =0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
Rebuild()=0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
Rebuild(const size_t size)=0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
Rebuild(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr)=0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
SetUsedSize(const size_t size)=0 (defined in FairMQMessage) | FairMQMessage | pure virtual |
~FairMQMessage() (defined in FairMQMessage) | FairMQMessage | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQMessage (FairMQTransportFactory *factory) |
+virtual void | Rebuild ()=0 |
+virtual void | Rebuild (const size_t size)=0 |
+virtual void | Rebuild (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr)=0 |
+virtual void * | GetData () const =0 |
+virtual size_t | GetSize () const =0 |
+virtual bool | SetUsedSize (const size_t size)=0 |
+virtual fair::mq::Transport | GetType () const =0 |
+FairMQTransportFactory * | GetTransport () |
+virtual void | Copy (const FairMQMessage &msg)=0 |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQMessageNN, including all inherited members.
+Copy(const FairMQMessage &msg) override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
FairMQMessage()=default (defined in FairMQMessage) | FairMQMessage | |
FairMQMessage(FairMQTransportFactory *factory) (defined in FairMQMessage) | FairMQMessage | inline |
FairMQMessageNN(FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageNN) | FairMQMessageNN | |
FairMQMessageNN(const size_t size, FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageNN) | FairMQMessageNN | |
FairMQMessageNN(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageNN) | FairMQMessageNN | |
FairMQMessageNN(FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageNN) | FairMQMessageNN | |
FairMQMessageNN(const FairMQMessageNN &)=delete (defined in FairMQMessageNN) | FairMQMessageNN | |
FairMQSocketNN (defined in FairMQMessageNN) | FairMQMessageNN | friend |
GetData() const override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
GetSize() const override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
GetTransport() (defined in FairMQMessage) | FairMQMessage | inline |
GetType() const override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
operator=(const FairMQMessageNN &)=delete (defined in FairMQMessageNN) | FairMQMessageNN | |
Rebuild() override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
Rebuild(const size_t size) override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
Rebuild(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
SetUsedSize(const size_t size) override (defined in FairMQMessageNN) | FairMQMessageNN | virtual |
~FairMQMessage() (defined in FairMQMessage) | FairMQMessage | inlinevirtual |
~FairMQMessageNN() override (defined in FairMQMessageNN) | FairMQMessageNN |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQMessageNN (FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageNN (const size_t size, FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageNN (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageNN (FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageNN (const FairMQMessageNN &)=delete |
+FairMQMessageNN | operator= (const FairMQMessageNN &)=delete |
+void | Rebuild () override |
+void | Rebuild (const size_t size) override |
+void | Rebuild (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override |
+void * | GetData () const override |
+size_t | GetSize () const override |
+bool | SetUsedSize (const size_t size) override |
+fair::mq::Transport | GetType () const override |
+void | Copy (const FairMQMessage &msg) override |
![]() | |
+ | FairMQMessage (FairMQTransportFactory *factory) |
+FairMQTransportFactory * | GetTransport () |
+Friends | |
+class | FairMQSocketNN |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQMessageZMQ, including all inherited members.
+ApplyUsedSize() (defined in FairMQMessageZMQ) | FairMQMessageZMQ | |
Copy(const FairMQMessage &msg) override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
FairMQMessage()=default (defined in FairMQMessage) | FairMQMessage | |
FairMQMessage(FairMQTransportFactory *factory) (defined in FairMQMessage) | FairMQMessage | inline |
FairMQMessageZMQ(FairMQTransportFactory *=nullptr) (defined in FairMQMessageZMQ) | FairMQMessageZMQ | |
FairMQMessageZMQ(const size_t size, FairMQTransportFactory *=nullptr) (defined in FairMQMessageZMQ) | FairMQMessageZMQ | |
FairMQMessageZMQ(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *=nullptr) (defined in FairMQMessageZMQ) | FairMQMessageZMQ | |
FairMQMessageZMQ(FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *=nullptr) (defined in FairMQMessageZMQ) | FairMQMessageZMQ | |
FairMQSocketZMQ (defined in FairMQMessageZMQ) | FairMQMessageZMQ | friend |
GetData() const override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
GetSize() const override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
GetTransport() (defined in FairMQMessage) | FairMQMessage | inline |
GetType() const override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
Rebuild() override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
Rebuild(const size_t size) override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
Rebuild(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
SetUsedSize(const size_t size) override (defined in FairMQMessageZMQ) | FairMQMessageZMQ | virtual |
~FairMQMessage() (defined in FairMQMessage) | FairMQMessage | inlinevirtual |
~FairMQMessageZMQ() override (defined in FairMQMessageZMQ) | FairMQMessageZMQ |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQMessageZMQ (FairMQTransportFactory *=nullptr) |
+ | FairMQMessageZMQ (const size_t size, FairMQTransportFactory *=nullptr) |
+ | FairMQMessageZMQ (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *=nullptr) |
+ | FairMQMessageZMQ (FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *=nullptr) |
+void | Rebuild () override |
+void | Rebuild (const size_t size) override |
+void | Rebuild (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override |
+void * | GetData () const override |
+size_t | GetSize () const override |
+bool | SetUsedSize (const size_t size) override |
+void | ApplyUsedSize () |
+fair::mq::Transport | GetType () const override |
+void | Copy (const FairMQMessage &msg) override |
![]() | |
+ | FairMQMessage (FairMQTransportFactory *factory) |
+FairMQTransportFactory * | GetTransport () |
+Friends | |
+class | FairMQSocketZMQ |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQMultiplier, including all inherited members.
+AddChannel(const std::string &name, FairMQChannel &&channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
Bind() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
ConditionalRun() | FairMQDevice | inlineprotectedvirtual |
Connect() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
END enum value (defined in FairMQDevice) | FairMQDevice | |
Error enum value (defined in FairMQDevice) | FairMQDevice | |
ERROR_FOUND enum value (defined in FairMQDevice) | FairMQDevice | |
Event enum name (defined in FairMQDevice) | FairMQDevice | |
EXITING enum value (defined in FairMQDevice) | FairMQDevice | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQMultiplier() (defined in FairMQMultiplier) | FairMQMultiplier | |
fChannels | FairMQDevice | |
fConfig | FairMQDevice | |
fId | FairMQDevice | protected |
fInChannelName (defined in FairMQMultiplier) | FairMQMultiplier | protected |
fInternalConfig | FairMQDevice | |
fMultipart (defined in FairMQMultiplier) | FairMQMultiplier | protected |
fNumOutputs (defined in FairMQMultiplier) | FairMQMultiplier | protected |
fOutChannelNames (defined in FairMQMultiplier) | FairMQMultiplier | protected |
fTransportFactory | FairMQDevice | protected |
fTransports | FairMQDevice | protected |
GetChannel(const std::string &channelName, const int index=0) (defined in FairMQDevice) | FairMQDevice | inline |
GetConfig() const | FairMQDevice | inline |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
HandleMultipartData(FairMQParts &, int) (defined in FairMQMultiplier) | FairMQMultiplier | protected |
HandleSingleData(std::unique_ptr< FairMQMessage > &, int) (defined in FairMQMultiplier) | FairMQMultiplier | protected |
IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
Init() | FairMQDevice | inlineprotectedvirtual |
INIT_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INIT_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
InitTask() | FairMQMultiplier | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
internal_IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
internal_READY enum value (defined in FairMQDevice) | FairMQDevice | |
LogSocketRates() | FairMQDevice | virtual |
NewMessage(Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewMessageFor(const std::string &channel, int index, Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const Ts &... inputs) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const std::vector< FairMQChannel *> &channels) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
OK enum value (defined in FairMQDevice) | FairMQDevice | |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMsgCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMultipartCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
operator=(const FairMQDevice &)=delete | FairMQDevice | |
Pause() __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run (defined in FairMQDevice) | FairMQDevice | protectedvirtual |
PostRun() | FairMQDevice | inlineprotectedvirtual |
PreRun() | FairMQDevice | inlineprotectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
READY enum value (defined in FairMQDevice) | FairMQDevice | |
Receive(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
Receive(FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
RegisterChannelEndpoint(const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) (defined in FairMQDevice) | FairMQDevice | inline |
RegisterChannelEndpoints() (defined in FairMQDevice) | FairMQDevice | inlinevirtual |
RESET_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESET_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
resume (defined in FairMQDevice) | FairMQDevice | protected |
RUN enum value (defined in FairMQDevice) | FairMQDevice | |
Run() | FairMQDevice | inlineprotectedvirtual |
RUNNING enum value (defined in FairMQDevice) | FairMQDevice | |
RunStateMachine() (defined in FairMQDevice) | FairMQDevice | inline |
Send(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Send(FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(fair::mq::ProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitTimeoutInS(int initTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
State enum name (defined in FairMQDevice) | FairMQDevice | |
STOP enum value (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQMultiplier() (defined in FairMQMultiplier) | FairMQMultiplier | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Protected Member Functions | |
+virtual void | InitTask () |
Task initialization (can be overloaded in child classes) | |
+bool | HandleSingleData (std::unique_ptr< FairMQMessage > &, int) |
+bool | HandleMultipartData (FairMQParts &, int) |
![]() | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+virtual void | Bind () |
+virtual void | Connect () |
+virtual void | Run () |
Runs the device (to be overloaded in child classes) | |
+virtual void | PreRun () |
Called in the RUNNING state once before executing the Run()/ConditionalRun() method. | |
+virtual bool | ConditionalRun () |
Called during RUNNING state repeatedly until it returns false or device state changes. | |
+virtual void | PostRun () |
Called in the RUNNING state once after executing the Run()/ConditionalRun() method. | |
+virtual void | Pause () __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run |
+Protected Attributes | |
+bool | fMultipart |
+int | fNumOutputs |
+std::string | fInChannelName |
+std::vector< std::string > | fOutChannelNames |
![]() | |
+std::shared_ptr< FairMQTransportFactory > | fTransportFactory |
Default transport factory. | |
+std::unordered_map< fair::mq::Transport, std::shared_ptr< FairMQTransportFactory > > | fTransports |
Container for transports. | |
+std::string | fId |
Device ID. | |
virtual void go to READY with STOP transition and back to RUNNING with RUN to | resume |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +STOP, +RESET_TASK, +RESET_DEVICE, + + internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (fair::mq::ProgOptions &config) |
Constructor with external fair::mq::ProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (fair::mq::ProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external fair::mq::ProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
+template<typename Serializer , typename DataType , typename... Args> | |
void | Serialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
+template<typename Deserializer , typename DataType , typename... Args> | |
void | Deserialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
int | Send (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
+auto | Transport () const -> FairMQTransportFactory * |
Getter for default transport factory. | |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename... Args> | |
FairMQMessagePtr | NewMessageFor (const std::string &channel, int index, Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessageFor (const std::string &channel, int index, const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessageFor (const std::string &channel, int index, const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel *> &channels) |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (fair::mq::ProgOptions &config) |
Assigns config to the device. | |
+fair::mq::ProgOptions * | GetConfig () const |
Get pointer to the config. | |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) |
+void | OnData (const std::string &channelName, InputMsgCallback callback) |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) |
+void | OnData (const std::string &channelName, InputMultipartCallback callback) |
+FairMQChannel & | GetChannel (const std::string &channelName, const int index=0) |
+virtual void | RegisterChannelEndpoints () |
+bool | RegisterChannelEndpoint (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) |
+void | PrintRegisteredChannels () |
+void | SetId (const std::string &id) |
+std::string | GetId () |
+const fair::mq::tools::Version | GetVersion () const |
+void | SetNumIoThreads (int numIoThreads) |
+int | GetNumIoThreads () const |
+void | SetNetworkInterface (const std::string &networkInterface) |
+std::string | GetNetworkInterface () const |
+void | SetDefaultTransport (const std::string &name) |
+std::string | GetDefaultTransport () const |
+void | SetInitTimeoutInS (int initTimeoutInS) |
+int | GetInitTimeoutInS () const |
void | SetTransport (const std::string &transport) |
+std::string | GetTransportName () const |
Gets the default transport name. | |
+void | SetRawCmdLineArgs (const std::vector< std::string > &args) |
+std::vector< std::string > | GetRawCmdLineArgs () const |
+void | RunStateMachine () |
template<typename Rep , typename Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &name, FairMQChannel &&channel) |
![]() | |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< fair::mq::ProgOptions > | fInternalConfig |
Internal program options configuration. | |
+fair::mq::ProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQParts, including all inherited members.
+AddPart(FairMQMessage *msg) | FairMQParts | inline |
AddPart(std::unique_ptr< FairMQMessage > &&msg) | FairMQParts | inline |
AddPart(std::unique_ptr< FairMQMessage > &&first, Ts &&... remaining) | FairMQParts | inline |
AddPart(FairMQParts &&other) | FairMQParts | inline |
At(const int index) | FairMQParts | inline |
AtRef(const int index) (defined in FairMQParts) | FairMQParts | inline |
begin() -> decltype(fParts.begin()) (defined in FairMQParts) | FairMQParts | inline |
cbegin() -> decltype(fParts.cbegin()) (defined in FairMQParts) | FairMQParts | inline |
cend() -> decltype(fParts.cend()) (defined in FairMQParts) | FairMQParts | inline |
const_iterator typedef (defined in FairMQParts) | FairMQParts | |
end() -> decltype(fParts.end()) (defined in FairMQParts) | FairMQParts | inline |
FairMQParts() | FairMQParts | inline |
FairMQParts(const FairMQParts &)=delete | FairMQParts | |
FairMQParts(FairMQParts &&p)=default | FairMQParts | |
FairMQParts(Ts &&... messages) | FairMQParts | inline |
fParts (defined in FairMQParts) | FairMQParts | |
iterator typedef (defined in FairMQParts) | FairMQParts | |
operator=(const FairMQParts &)=delete | FairMQParts | |
operator[](const int index) | FairMQParts | inline |
Size() const | FairMQParts | inline |
~FairMQParts() | FairMQParts | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage, used for sending multi-part messages. + More...
+ +#include <FairMQParts.h>
+Public Types | |
+using | iterator = container::iterator |
+using | const_iterator = container::const_iterator |
+Public Member Functions | |
+ | FairMQParts () |
Default constructor. | |
+ | FairMQParts (const FairMQParts &)=delete |
Copy Constructor. | |
+ | FairMQParts (FairMQParts &&p)=default |
Move constructor. | |
+FairMQParts & | operator= (const FairMQParts &)=delete |
Assignment operator. | |
+template<typename... Ts> | |
FairMQParts (Ts &&... messages) | |
Constructor from argument pack of std::unique_ptr<FairMQMessage> rvalues. | |
+ | ~FairMQParts () |
Default destructor. | |
void | AddPart (FairMQMessage *msg) |
void | AddPart (std::unique_ptr< FairMQMessage > &&msg) |
+template<typename... Ts> | |
void | AddPart (std::unique_ptr< FairMQMessage > &&first, Ts &&... remaining) |
Add variable list of parts to the container (move) | |
+void | AddPart (FairMQParts &&other) |
Add content of another object by move. | |
FairMQMessage & | operator[] (const int index) |
std::unique_ptr< FairMQMessage > & | At (const int index) |
+FairMQMessage & | AtRef (const int index) |
int | Size () const |
+auto | begin () -> decltype(fParts.begin()) |
+auto | end () -> decltype(fParts.end()) |
+auto | cbegin () -> decltype(fParts.cbegin()) |
+auto | cend () -> decltype(fParts.cend()) |
+Public Attributes | |
+container | fParts |
FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage, used for sending multi-part messages.
+
+
|
+ +inline | +
Adds part (FairMQMessage) to the container
msg | message pointer (for example created with NewMessage() method of FairMQDevice) |
+
|
+ +inline | +
Adds part (std::unique_ptr<FairMQMessage>&) to the container (move)
msg | unique pointer to FairMQMessage rvalue ref (move required when passing argument) |
+
|
+ +inline | +
Get reference to unique pointer to part in the container at index (with bounds check)
index | container index |
+
|
+ +inline | +
Get reference to part in the container at index (without bounds check)
index | container index |
+
|
+ +inline | +
Get number of parts in the container
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQPoller, including all inherited members.
+CheckInput(const int index)=0 (defined in FairMQPoller) | FairMQPoller | pure virtual |
CheckInput(const std::string &channelKey, const int index)=0 (defined in FairMQPoller) | FairMQPoller | pure virtual |
CheckOutput(const int index)=0 (defined in FairMQPoller) | FairMQPoller | pure virtual |
CheckOutput(const std::string &channelKey, const int index)=0 (defined in FairMQPoller) | FairMQPoller | pure virtual |
Poll(const int timeout)=0 (defined in FairMQPoller) | FairMQPoller | pure virtual |
~FairMQPoller() (defined in FairMQPoller) | FairMQPoller | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQPollerNN, including all inherited members.
+CheckInput(const int index) override (defined in FairMQPollerNN) | FairMQPollerNN | virtual |
CheckInput(const std::string &channelKey, const int index) override (defined in FairMQPollerNN) | FairMQPollerNN | virtual |
CheckOutput(const int index) override (defined in FairMQPollerNN) | FairMQPollerNN | virtual |
CheckOutput(const std::string &channelKey, const int index) override (defined in FairMQPollerNN) | FairMQPollerNN | virtual |
FairMQChannel (defined in FairMQPollerNN) | FairMQPollerNN | friend |
FairMQPollerNN(const std::vector< FairMQChannel > &channels) (defined in FairMQPollerNN) | FairMQPollerNN | |
FairMQPollerNN(const std::vector< FairMQChannel *> &channels) (defined in FairMQPollerNN) | FairMQPollerNN | |
FairMQPollerNN(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) (defined in FairMQPollerNN) | FairMQPollerNN | |
FairMQPollerNN(const FairMQPollerNN &)=delete (defined in FairMQPollerNN) | FairMQPollerNN | |
FairMQTransportFactoryNN (defined in FairMQPollerNN) | FairMQPollerNN | friend |
operator=(const FairMQPollerNN &)=delete (defined in FairMQPollerNN) | FairMQPollerNN | |
Poll(const int timeout) override (defined in FairMQPollerNN) | FairMQPollerNN | virtual |
SetItemEvents(nn_pollfd &item, const int type) (defined in FairMQPollerNN) | FairMQPollerNN | |
~FairMQPoller() (defined in FairMQPoller) | FairMQPoller | inlinevirtual |
~FairMQPollerNN() override (defined in FairMQPollerNN) | FairMQPollerNN |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQPollerNN (const std::vector< FairMQChannel > &channels) |
+ | FairMQPollerNN (const std::vector< FairMQChannel *> &channels) |
+ | FairMQPollerNN (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) |
+ | FairMQPollerNN (const FairMQPollerNN &)=delete |
+FairMQPollerNN | operator= (const FairMQPollerNN &)=delete |
+void | SetItemEvents (nn_pollfd &item, const int type) |
+void | Poll (const int timeout) override |
+bool | CheckInput (const int index) override |
+bool | CheckOutput (const int index) override |
+bool | CheckInput (const std::string &channelKey, const int index) override |
+bool | CheckOutput (const std::string &channelKey, const int index) override |
+Friends | |
+class | FairMQChannel |
+class | FairMQTransportFactoryNN |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQPollerZMQ, including all inherited members.
+CheckInput(const int index) override (defined in FairMQPollerZMQ) | FairMQPollerZMQ | virtual |
CheckInput(const std::string &channelKey, const int index) override (defined in FairMQPollerZMQ) | FairMQPollerZMQ | virtual |
CheckOutput(const int index) override (defined in FairMQPollerZMQ) | FairMQPollerZMQ | virtual |
CheckOutput(const std::string &channelKey, const int index) override (defined in FairMQPollerZMQ) | FairMQPollerZMQ | virtual |
FairMQChannel (defined in FairMQPollerZMQ) | FairMQPollerZMQ | friend |
FairMQPollerZMQ(const std::vector< FairMQChannel > &channels) (defined in FairMQPollerZMQ) | FairMQPollerZMQ | |
FairMQPollerZMQ(const std::vector< FairMQChannel *> &channels) (defined in FairMQPollerZMQ) | FairMQPollerZMQ | |
FairMQPollerZMQ(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) (defined in FairMQPollerZMQ) | FairMQPollerZMQ | |
FairMQPollerZMQ(const FairMQPollerZMQ &)=delete (defined in FairMQPollerZMQ) | FairMQPollerZMQ | |
FairMQTransportFactoryZMQ (defined in FairMQPollerZMQ) | FairMQPollerZMQ | friend |
operator=(const FairMQPollerZMQ &)=delete (defined in FairMQPollerZMQ) | FairMQPollerZMQ | |
Poll(const int timeout) override (defined in FairMQPollerZMQ) | FairMQPollerZMQ | virtual |
SetItemEvents(zmq_pollitem_t &item, const int type) (defined in FairMQPollerZMQ) | FairMQPollerZMQ | |
~FairMQPoller() (defined in FairMQPoller) | FairMQPoller | inlinevirtual |
~FairMQPollerZMQ() override (defined in FairMQPollerZMQ) | FairMQPollerZMQ |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQPollerZMQ (const std::vector< FairMQChannel > &channels) |
+ | FairMQPollerZMQ (const std::vector< FairMQChannel *> &channels) |
+ | FairMQPollerZMQ (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) |
+ | FairMQPollerZMQ (const FairMQPollerZMQ &)=delete |
+FairMQPollerZMQ | operator= (const FairMQPollerZMQ &)=delete |
+void | SetItemEvents (zmq_pollitem_t &item, const int type) |
+void | Poll (const int timeout) override |
+bool | CheckInput (const int index) override |
+bool | CheckOutput (const int index) override |
+bool | CheckInput (const std::string &channelKey, const int index) override |
+bool | CheckOutput (const std::string &channelKey, const int index) override |
+Friends | |
+class | FairMQChannel |
+class | FairMQTransportFactoryZMQ |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQProxy, including all inherited members.
+AddChannel(const std::string &name, FairMQChannel &&channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
Bind() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
ConditionalRun() | FairMQDevice | inlineprotectedvirtual |
Connect() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
END enum value (defined in FairMQDevice) | FairMQDevice | |
Error enum value (defined in FairMQDevice) | FairMQDevice | |
ERROR_FOUND enum value (defined in FairMQDevice) | FairMQDevice | |
Event enum name (defined in FairMQDevice) | FairMQDevice | |
EXITING enum value (defined in FairMQDevice) | FairMQDevice | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQProxy() (defined in FairMQProxy) | FairMQProxy | |
fChannels | FairMQDevice | |
fConfig | FairMQDevice | |
fId | FairMQDevice | protected |
fInChannelName (defined in FairMQProxy) | FairMQProxy | protected |
fInternalConfig | FairMQDevice | |
fMultipart (defined in FairMQProxy) | FairMQProxy | protected |
fOutChannelName (defined in FairMQProxy) | FairMQProxy | protected |
fTransportFactory | FairMQDevice | protected |
fTransports | FairMQDevice | protected |
GetChannel(const std::string &channelName, const int index=0) (defined in FairMQDevice) | FairMQDevice | inline |
GetConfig() const | FairMQDevice | inline |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
Init() | FairMQDevice | inlineprotectedvirtual |
INIT_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INIT_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
InitTask() | FairMQProxy | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
internal_IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
internal_READY enum value (defined in FairMQDevice) | FairMQDevice | |
LogSocketRates() | FairMQDevice | virtual |
NewMessage(Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewMessageFor(const std::string &channel, int index, Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const Ts &... inputs) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const std::vector< FairMQChannel *> &channels) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
OK enum value (defined in FairMQDevice) | FairMQDevice | |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMsgCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMultipartCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
operator=(const FairMQDevice &)=delete | FairMQDevice | |
Pause() __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run (defined in FairMQDevice) | FairMQDevice | protectedvirtual |
PostRun() | FairMQDevice | inlineprotectedvirtual |
PreRun() | FairMQDevice | inlineprotectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
READY enum value (defined in FairMQDevice) | FairMQDevice | |
Receive(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
Receive(FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
RegisterChannelEndpoint(const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) (defined in FairMQDevice) | FairMQDevice | inline |
RegisterChannelEndpoints() (defined in FairMQDevice) | FairMQDevice | inlinevirtual |
RESET_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESET_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
resume (defined in FairMQDevice) | FairMQDevice | protected |
RUN enum value (defined in FairMQDevice) | FairMQDevice | |
Run() | FairMQProxy | protectedvirtual |
RUNNING enum value (defined in FairMQDevice) | FairMQDevice | |
RunStateMachine() (defined in FairMQDevice) | FairMQDevice | inline |
Send(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Send(FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(fair::mq::ProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitTimeoutInS(int initTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
State enum name (defined in FairMQDevice) | FairMQDevice | |
STOP enum value (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQProxy() (defined in FairMQProxy) | FairMQProxy | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <FairMQProxy.h>
+Protected Member Functions | |
+virtual void | Run () |
Runs the device (to be overloaded in child classes) | |
+virtual void | InitTask () |
Task initialization (can be overloaded in child classes) | |
![]() | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+virtual void | Bind () |
+virtual void | Connect () |
+virtual void | PreRun () |
Called in the RUNNING state once before executing the Run()/ConditionalRun() method. | |
+virtual bool | ConditionalRun () |
Called during RUNNING state repeatedly until it returns false or device state changes. | |
+virtual void | PostRun () |
Called in the RUNNING state once after executing the Run()/ConditionalRun() method. | |
+virtual void | Pause () __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run |
+Protected Attributes | |
+bool | fMultipart |
+std::string | fInChannelName |
+std::string | fOutChannelName |
![]() | |
+std::shared_ptr< FairMQTransportFactory > | fTransportFactory |
Default transport factory. | |
+std::unordered_map< fair::mq::Transport, std::shared_ptr< FairMQTransportFactory > > | fTransports |
Container for transports. | |
+std::string | fId |
Device ID. | |
virtual void go to READY with STOP transition and back to RUNNING with RUN to | resume |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +STOP, +RESET_TASK, +RESET_DEVICE, + + internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (fair::mq::ProgOptions &config) |
Constructor with external fair::mq::ProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (fair::mq::ProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external fair::mq::ProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
+template<typename Serializer , typename DataType , typename... Args> | |
void | Serialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
+template<typename Deserializer , typename DataType , typename... Args> | |
void | Deserialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
int | Send (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
+auto | Transport () const -> FairMQTransportFactory * |
Getter for default transport factory. | |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename... Args> | |
FairMQMessagePtr | NewMessageFor (const std::string &channel, int index, Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessageFor (const std::string &channel, int index, const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessageFor (const std::string &channel, int index, const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel *> &channels) |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (fair::mq::ProgOptions &config) |
Assigns config to the device. | |
+fair::mq::ProgOptions * | GetConfig () const |
Get pointer to the config. | |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) |
+void | OnData (const std::string &channelName, InputMsgCallback callback) |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) |
+void | OnData (const std::string &channelName, InputMultipartCallback callback) |
+FairMQChannel & | GetChannel (const std::string &channelName, const int index=0) |
+virtual void | RegisterChannelEndpoints () |
+bool | RegisterChannelEndpoint (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) |
+void | PrintRegisteredChannels () |
+void | SetId (const std::string &id) |
+std::string | GetId () |
+const fair::mq::tools::Version | GetVersion () const |
+void | SetNumIoThreads (int numIoThreads) |
+int | GetNumIoThreads () const |
+void | SetNetworkInterface (const std::string &networkInterface) |
+std::string | GetNetworkInterface () const |
+void | SetDefaultTransport (const std::string &name) |
+std::string | GetDefaultTransport () const |
+void | SetInitTimeoutInS (int initTimeoutInS) |
+int | GetInitTimeoutInS () const |
void | SetTransport (const std::string &transport) |
+std::string | GetTransportName () const |
Gets the default transport name. | |
+void | SetRawCmdLineArgs (const std::vector< std::string > &args) |
+std::vector< std::string > | GetRawCmdLineArgs () const |
+void | RunStateMachine () |
template<typename Rep , typename Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &name, FairMQChannel &&channel) |
![]() | |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< fair::mq::ProgOptions > | fInternalConfig |
Internal program options configuration. | |
+fair::mq::ProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQSink, including all inherited members.
+AddChannel(const std::string &name, FairMQChannel &&channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
Bind() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
ConditionalRun() | FairMQDevice | inlineprotectedvirtual |
Connect() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
END enum value (defined in FairMQDevice) | FairMQDevice | |
Error enum value (defined in FairMQDevice) | FairMQDevice | |
ERROR_FOUND enum value (defined in FairMQDevice) | FairMQDevice | |
Event enum name (defined in FairMQDevice) | FairMQDevice | |
EXITING enum value (defined in FairMQDevice) | FairMQDevice | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQSink() (defined in FairMQSink) | FairMQSink | inline |
fChannels | FairMQDevice | |
fConfig | FairMQDevice | |
fId | FairMQDevice | protected |
fInChannelName (defined in FairMQSink) | FairMQSink | protected |
fInternalConfig | FairMQDevice | |
fMaxIterations (defined in FairMQSink) | FairMQSink | protected |
fMultipart (defined in FairMQSink) | FairMQSink | protected |
fNumIterations (defined in FairMQSink) | FairMQSink | protected |
fTransportFactory | FairMQDevice | protected |
fTransports | FairMQDevice | protected |
GetChannel(const std::string &channelName, const int index=0) (defined in FairMQDevice) | FairMQDevice | inline |
GetConfig() const | FairMQDevice | inline |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
Init() | FairMQDevice | inlineprotectedvirtual |
INIT_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INIT_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
InitTask() | FairMQSink | inlineprotectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
internal_IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
internal_READY enum value (defined in FairMQDevice) | FairMQDevice | |
LogSocketRates() | FairMQDevice | virtual |
NewMessage(Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewMessageFor(const std::string &channel, int index, Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const Ts &... inputs) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const std::vector< FairMQChannel *> &channels) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
OK enum value (defined in FairMQDevice) | FairMQDevice | |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMsgCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMultipartCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
operator=(const FairMQDevice &)=delete | FairMQDevice | |
Pause() __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run (defined in FairMQDevice) | FairMQDevice | protectedvirtual |
PostRun() | FairMQDevice | inlineprotectedvirtual |
PreRun() | FairMQDevice | inlineprotectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
READY enum value (defined in FairMQDevice) | FairMQDevice | |
Receive(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
Receive(FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
RegisterChannelEndpoint(const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) (defined in FairMQDevice) | FairMQDevice | inline |
RegisterChannelEndpoints() (defined in FairMQDevice) | FairMQDevice | inlinevirtual |
RESET_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESET_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
resume (defined in FairMQDevice) | FairMQDevice | protected |
RUN enum value (defined in FairMQDevice) | FairMQDevice | |
Run() | FairMQSink | inlineprotectedvirtual |
RUNNING enum value (defined in FairMQDevice) | FairMQDevice | |
RunStateMachine() (defined in FairMQDevice) | FairMQDevice | inline |
Send(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Send(FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(fair::mq::ProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitTimeoutInS(int initTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
State enum name (defined in FairMQDevice) | FairMQDevice | |
STOP enum value (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQSink() (defined in FairMQSink) | FairMQSink | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <FairMQSink.h>
+Protected Member Functions | |
+virtual void | InitTask () |
Task initialization (can be overloaded in child classes) | |
+virtual void | Run () |
Runs the device (to be overloaded in child classes) | |
![]() | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+virtual void | Bind () |
+virtual void | Connect () |
+virtual void | PreRun () |
Called in the RUNNING state once before executing the Run()/ConditionalRun() method. | |
+virtual bool | ConditionalRun () |
Called during RUNNING state repeatedly until it returns false or device state changes. | |
+virtual void | PostRun () |
Called in the RUNNING state once after executing the Run()/ConditionalRun() method. | |
+virtual void | Pause () __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run |
+Protected Attributes | |
+bool | fMultipart |
+uint64_t | fMaxIterations |
+uint64_t | fNumIterations |
+std::string | fInChannelName |
![]() | |
+std::shared_ptr< FairMQTransportFactory > | fTransportFactory |
Default transport factory. | |
+std::unordered_map< fair::mq::Transport, std::shared_ptr< FairMQTransportFactory > > | fTransports |
Container for transports. | |
+std::string | fId |
Device ID. | |
virtual void go to READY with STOP transition and back to RUNNING with RUN to | resume |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +STOP, +RESET_TASK, +RESET_DEVICE, + + internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (fair::mq::ProgOptions &config) |
Constructor with external fair::mq::ProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (fair::mq::ProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external fair::mq::ProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
+template<typename Serializer , typename DataType , typename... Args> | |
void | Serialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
+template<typename Deserializer , typename DataType , typename... Args> | |
void | Deserialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
int | Send (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
+auto | Transport () const -> FairMQTransportFactory * |
Getter for default transport factory. | |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename... Args> | |
FairMQMessagePtr | NewMessageFor (const std::string &channel, int index, Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessageFor (const std::string &channel, int index, const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessageFor (const std::string &channel, int index, const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel *> &channels) |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (fair::mq::ProgOptions &config) |
Assigns config to the device. | |
+fair::mq::ProgOptions * | GetConfig () const |
Get pointer to the config. | |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) |
+void | OnData (const std::string &channelName, InputMsgCallback callback) |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) |
+void | OnData (const std::string &channelName, InputMultipartCallback callback) |
+FairMQChannel & | GetChannel (const std::string &channelName, const int index=0) |
+virtual void | RegisterChannelEndpoints () |
+bool | RegisterChannelEndpoint (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) |
+void | PrintRegisteredChannels () |
+void | SetId (const std::string &id) |
+std::string | GetId () |
+const fair::mq::tools::Version | GetVersion () const |
+void | SetNumIoThreads (int numIoThreads) |
+int | GetNumIoThreads () const |
+void | SetNetworkInterface (const std::string &networkInterface) |
+std::string | GetNetworkInterface () const |
+void | SetDefaultTransport (const std::string &name) |
+std::string | GetDefaultTransport () const |
+void | SetInitTimeoutInS (int initTimeoutInS) |
+int | GetInitTimeoutInS () const |
void | SetTransport (const std::string &transport) |
+std::string | GetTransportName () const |
Gets the default transport name. | |
+void | SetRawCmdLineArgs (const std::vector< std::string > &args) |
+std::vector< std::string > | GetRawCmdLineArgs () const |
+void | RunStateMachine () |
template<typename Rep , typename Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &name, FairMQChannel &&channel) |
![]() | |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< fair::mq::ProgOptions > | fInternalConfig |
Internal program options configuration. | |
+fair::mq::ProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQSocket, including all inherited members.
+Bind(const std::string &address)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
Close()=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
Connect(const std::string &address)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocket(FairMQTransportFactory *fac) (defined in FairMQSocket) | FairMQSocket | inline |
GetBytesRx() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetBytesTx() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetId() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetLinger() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetMessagesRx() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetMessagesTx() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetOption(const std::string &option, void *value, size_t *valueSize)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetRcvBufSize() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetRcvKernelSize() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetSndBufSize() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetSndKernelSize() const =0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
GetTransport() (defined in FairMQSocket) | FairMQSocket | inline |
Receive(FairMQMessagePtr &msg, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
Receive(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
Send(FairMQMessagePtr &msg, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
Send(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetLinger(const int value)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetOption(const std::string &option, const void *value, size_t valueSize)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetRcvBufSize(const int value)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetRcvKernelSize(const int value)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetSndBufSize(const int value)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetSndKernelSize(const int value)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetTransport(FairMQTransportFactory *transport) (defined in FairMQSocket) | FairMQSocket | inline |
~FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQSocket (FairMQTransportFactory *fac) |
+virtual std::string | GetId () const =0 |
+virtual bool | Bind (const std::string &address)=0 |
+virtual bool | Connect (const std::string &address)=0 |
+virtual int | Send (FairMQMessagePtr &msg, int timeout=-1)=0 |
+virtual int | Receive (FairMQMessagePtr &msg, int timeout=-1)=0 |
+virtual int64_t | Send (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 |
+virtual int64_t | Receive (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=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 void | SetLinger (const int value)=0 |
+virtual int | GetLinger () const =0 |
+virtual void | SetSndBufSize (const int value)=0 |
+virtual int | GetSndBufSize () const =0 |
+virtual void | SetRcvBufSize (const int value)=0 |
+virtual int | GetRcvBufSize () const =0 |
+virtual void | SetSndKernelSize (const int value)=0 |
+virtual int | GetSndKernelSize () const =0 |
+virtual void | SetRcvKernelSize (const int value)=0 |
+virtual int | GetRcvKernelSize () const =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 |
+FairMQTransportFactory * | GetTransport () |
+void | SetTransport (FairMQTransportFactory *transport) |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQSocketNN, including all inherited members.
+Bind(const std::string &address) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
Close() override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
Connect(const std::string &address) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocket(FairMQTransportFactory *fac) (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocketNN(const std::string &type, const std::string &name, const std::string &id="", FairMQTransportFactory *fac=nullptr) (defined in FairMQSocketNN) | FairMQSocketNN | |
FairMQSocketNN(const FairMQSocketNN &)=delete (defined in FairMQSocketNN) | FairMQSocketNN | |
GetBytesRx() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetBytesTx() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetConstant(const std::string &constant) (defined in FairMQSocketNN) | FairMQSocketNN | static |
GetId() const override (defined in FairMQSocketNN) | FairMQSocketNN | inlinevirtual |
GetLinger() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetMessagesRx() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetMessagesTx() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetOption(const std::string &option, void *value, size_t *valueSize) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetRcvBufSize() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetRcvKernelSize() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetSndBufSize() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetSndKernelSize() const override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
GetSocket() const (defined in FairMQSocketNN) | FairMQSocketNN | |
GetTransport() (defined in FairMQSocket) | FairMQSocket | inline |
Interrupt() (defined in FairMQSocketNN) | FairMQSocketNN | static |
operator=(const FairMQSocketNN &)=delete (defined in FairMQSocketNN) | FairMQSocketNN | |
Receive(FairMQMessagePtr &msg, const int timeout=-1) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
Receive(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
Resume() (defined in FairMQSocketNN) | FairMQSocketNN | static |
Send(FairMQMessagePtr &msg, const int timeout=-1) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
Send(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
SetLinger(const int value) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
SetOption(const std::string &option, const void *value, size_t valueSize) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
SetRcvBufSize(const int value) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
SetRcvKernelSize(const int value) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
SetSndBufSize(const int value) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
SetSndKernelSize(const int value) override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
SetTransport(FairMQTransportFactory *transport) (defined in FairMQSocket) | FairMQSocket | inline |
~FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inlinevirtual |
~FairMQSocketNN() override (defined in FairMQSocketNN) | FairMQSocketNN |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQSocketNN (const std::string &type, const std::string &name, const std::string &id="", FairMQTransportFactory *fac=nullptr) |
+ | FairMQSocketNN (const FairMQSocketNN &)=delete |
+FairMQSocketNN | operator= (const FairMQSocketNN &)=delete |
+std::string | GetId () const override |
+bool | Bind (const std::string &address) override |
+bool | Connect (const std::string &address) override |
+int | Send (FairMQMessagePtr &msg, const int timeout=-1) override |
+int | Receive (FairMQMessagePtr &msg, const int timeout=-1) override |
+int64_t | Send (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override |
+int64_t | Receive (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override |
+int | GetSocket () const |
+void | Close () override |
+void | SetOption (const std::string &option, const void *value, size_t valueSize) override |
+void | GetOption (const std::string &option, void *value, size_t *valueSize) override |
+void | SetLinger (const int value) override |
+int | GetLinger () const override |
+void | SetSndBufSize (const int value) override |
+int | GetSndBufSize () const override |
+void | SetRcvBufSize (const int value) override |
+int | GetRcvBufSize () const override |
+void | SetSndKernelSize (const int value) override |
+int | GetSndKernelSize () const override |
+void | SetRcvKernelSize (const int value) override |
+int | GetRcvKernelSize () const override |
+unsigned long | GetBytesTx () const override |
+unsigned long | GetBytesRx () const override |
+unsigned long | GetMessagesTx () const override |
+unsigned long | GetMessagesRx () const override |
![]() | |
+ | FairMQSocket (FairMQTransportFactory *fac) |
+FairMQTransportFactory * | GetTransport () |
+void | SetTransport (FairMQTransportFactory *transport) |
+Static Public Member Functions | |
+static void | Interrupt () |
+static void | Resume () |
+static int | GetConstant (const std::string &constant) |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQSocketZMQ, including all inherited members.
+Bind(const std::string &address) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
Close() override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
Connect(const std::string &address) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocket(FairMQTransportFactory *fac) (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocketZMQ(const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr, FairMQTransportFactory *factory=nullptr) (defined in FairMQSocketZMQ) | FairMQSocketZMQ | |
FairMQSocketZMQ(const FairMQSocketZMQ &)=delete (defined in FairMQSocketZMQ) | FairMQSocketZMQ | |
GetBytesRx() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetBytesTx() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetConstant(const std::string &constant) (defined in FairMQSocketZMQ) | FairMQSocketZMQ | static |
GetId() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | inlinevirtual |
GetLinger() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetMessagesRx() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetMessagesTx() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetOption(const std::string &option, void *value, size_t *valueSize) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetRcvBufSize() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetRcvKernelSize() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetSndBufSize() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetSndKernelSize() const override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
GetSocket() const (defined in FairMQSocketZMQ) | FairMQSocketZMQ | |
GetTransport() (defined in FairMQSocket) | FairMQSocket | inline |
Interrupt() (defined in FairMQSocketZMQ) | FairMQSocketZMQ | static |
operator=(const FairMQSocketZMQ &)=delete (defined in FairMQSocketZMQ) | FairMQSocketZMQ | |
Receive(FairMQMessagePtr &msg, const int timeout=-1) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
Receive(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
Resume() (defined in FairMQSocketZMQ) | FairMQSocketZMQ | static |
Send(FairMQMessagePtr &msg, const int timeout=-1) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
Send(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
SetLinger(const int value) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
SetOption(const std::string &option, const void *value, size_t valueSize) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
SetRcvBufSize(const int value) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
SetRcvKernelSize(const int value) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
SetSndBufSize(const int value) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
SetSndKernelSize(const int value) override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
SetTransport(FairMQTransportFactory *transport) (defined in FairMQSocket) | FairMQSocket | inline |
~FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inlinevirtual |
~FairMQSocketZMQ() override (defined in FairMQSocketZMQ) | FairMQSocketZMQ |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQSocketZMQ (const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr, FairMQTransportFactory *factory=nullptr) |
+ | FairMQSocketZMQ (const FairMQSocketZMQ &)=delete |
+FairMQSocketZMQ | operator= (const FairMQSocketZMQ &)=delete |
+std::string | GetId () const override |
+bool | Bind (const std::string &address) override |
+bool | Connect (const std::string &address) override |
+int | Send (FairMQMessagePtr &msg, const int timeout=-1) override |
+int | Receive (FairMQMessagePtr &msg, const int timeout=-1) override |
+int64_t | Send (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override |
+int64_t | Receive (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override |
+void * | GetSocket () const |
+void | Close () override |
+void | SetOption (const std::string &option, const void *value, size_t valueSize) override |
+void | GetOption (const std::string &option, void *value, size_t *valueSize) override |
+void | SetLinger (const int value) override |
+int | GetLinger () const override |
+void | SetSndBufSize (const int value) override |
+int | GetSndBufSize () const override |
+void | SetRcvBufSize (const int value) override |
+int | GetRcvBufSize () const override |
+void | SetSndKernelSize (const int value) override |
+int | GetSndKernelSize () const override |
+void | SetRcvKernelSize (const int value) override |
+int | GetRcvKernelSize () const override |
+unsigned long | GetBytesTx () const override |
+unsigned long | GetBytesRx () const override |
+unsigned long | GetMessagesTx () const override |
+unsigned long | GetMessagesRx () const override |
![]() | |
+ | FairMQSocket (FairMQTransportFactory *fac) |
+FairMQTransportFactory * | GetTransport () |
+void | SetTransport (FairMQTransportFactory *transport) |
+Static Public Member Functions | |
+static void | Interrupt () |
+static void | Resume () |
+static int | GetConstant (const std::string &constant) |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQSplitter, including all inherited members.
+AddChannel(const std::string &name, FairMQChannel &&channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
Bind() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
ConditionalRun() | FairMQDevice | inlineprotectedvirtual |
Connect() (defined in FairMQDevice) | FairMQDevice | inlineprotectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
END enum value (defined in FairMQDevice) | FairMQDevice | |
Error enum value (defined in FairMQDevice) | FairMQDevice | |
ERROR_FOUND enum value (defined in FairMQDevice) | FairMQDevice | |
Event enum name (defined in FairMQDevice) | FairMQDevice | |
EXITING enum value (defined in FairMQDevice) | FairMQDevice | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(fair::mq::ProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQSplitter() (defined in FairMQSplitter) | FairMQSplitter | |
fChannels | FairMQDevice | |
fConfig | FairMQDevice | |
fDirection (defined in FairMQSplitter) | FairMQSplitter | protected |
fId | FairMQDevice | protected |
fInChannelName (defined in FairMQSplitter) | FairMQSplitter | protected |
fInternalConfig | FairMQDevice | |
fMultipart (defined in FairMQSplitter) | FairMQSplitter | protected |
fNumOutputs (defined in FairMQSplitter) | FairMQSplitter | protected |
fOutChannelName (defined in FairMQSplitter) | FairMQSplitter | protected |
fTransportFactory | FairMQDevice | protected |
fTransports | FairMQDevice | protected |
GetChannel(const std::string &channelName, const int index=0) (defined in FairMQDevice) | FairMQDevice | inline |
GetConfig() const | FairMQDevice | inline |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
HandleMultipartData(FairMQParts &, int) (defined in FairMQSplitter) | FairMQSplitter | protected |
HandleSingleData(std::unique_ptr< FairMQMessage > &, int) (defined in FairMQSplitter) | FairMQSplitter | protected |
IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
Init() | FairMQDevice | inlineprotectedvirtual |
INIT_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INIT_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
INITIALIZING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
InitTask() | FairMQSplitter | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQDevice) | FairMQDevice | |
internal_IDLE enum value (defined in FairMQDevice) | FairMQDevice | |
internal_READY enum value (defined in FairMQDevice) | FairMQDevice | |
LogSocketRates() | FairMQDevice | virtual |
NewMessage(Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewMessageFor(const std::string &channel, int index, Args &&... args) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const Ts &... inputs) (defined in FairMQDevice) | FairMQDevice | inline |
NewPoller(const std::vector< FairMQChannel *> &channels) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewSimpleMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessage(const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewStaticMessageFor(const std::string &channel, int index, const T &data) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) (defined in FairMQDevice) | FairMQDevice | inline |
OK enum value (defined in FairMQDevice) | FairMQDevice | |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMsgCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) (defined in FairMQDevice) | FairMQDevice | inline |
OnData(const std::string &channelName, InputMultipartCallback callback) (defined in FairMQDevice) | FairMQDevice | inline |
operator=(const FairMQDevice &)=delete | FairMQDevice | |
Pause() __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run (defined in FairMQDevice) | FairMQDevice | protectedvirtual |
PostRun() | FairMQDevice | inlineprotectedvirtual |
PreRun() | FairMQDevice | inlineprotectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
READY enum value (defined in FairMQDevice) | FairMQDevice | |
Receive(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
Receive(FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) | FairMQDevice | inline |
RegisterChannelEndpoint(const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) (defined in FairMQDevice) | FairMQDevice | inline |
RegisterChannelEndpoints() (defined in FairMQDevice) | FairMQDevice | inlinevirtual |
RESET_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESET_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_DEVICE enum value (defined in FairMQDevice) | FairMQDevice | |
RESETTING_TASK enum value (defined in FairMQDevice) | FairMQDevice | |
resume (defined in FairMQDevice) | FairMQDevice | protected |
RUN enum value (defined in FairMQDevice) | FairMQDevice | |
Run() | FairMQDevice | inlineprotectedvirtual |
RUNNING enum value (defined in FairMQDevice) | FairMQDevice | |
RunStateMachine() (defined in FairMQDevice) | FairMQDevice | inline |
Send(FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Send(FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) | FairMQDevice | inline |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(fair::mq::ProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitTimeoutInS(int initTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
State enum name (defined in FairMQDevice) | FairMQDevice | |
STOP enum value (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQSplitter() (defined in FairMQSplitter) | FairMQSplitter | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <FairMQSplitter.h>
+Protected Member Functions | |
+virtual void | InitTask () |
Task initialization (can be overloaded in child classes) | |
+bool | HandleSingleData (std::unique_ptr< FairMQMessage > &, int) |
+bool | HandleMultipartData (FairMQParts &, int) |
![]() | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+virtual void | Bind () |
+virtual void | Connect () |
+virtual void | Run () |
Runs the device (to be overloaded in child classes) | |
+virtual void | PreRun () |
Called in the RUNNING state once before executing the Run()/ConditionalRun() method. | |
+virtual bool | ConditionalRun () |
Called during RUNNING state repeatedly until it returns false or device state changes. | |
+virtual void | PostRun () |
Called in the RUNNING state once after executing the Run()/ConditionalRun() method. | |
+virtual void | Pause () __attribute__((deprecated("PAUSE state is removed. This method is never called. To pause Run |
+Protected Attributes | |
+bool | fMultipart |
+int | fNumOutputs |
+int | fDirection |
+std::string | fInChannelName |
+std::string | fOutChannelName |
![]() | |
+std::shared_ptr< FairMQTransportFactory > | fTransportFactory |
Default transport factory. | |
+std::unordered_map< fair::mq::Transport, std::shared_ptr< FairMQTransportFactory > > | fTransports |
Container for transports. | |
+std::string | fId |
Device ID. | |
virtual void go to READY with STOP transition and back to RUNNING with RUN to | resume |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +STOP, +RESET_TASK, +RESET_DEVICE, + + internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (fair::mq::ProgOptions &config) |
Constructor with external fair::mq::ProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (fair::mq::ProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external fair::mq::ProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
+template<typename Serializer , typename DataType , typename... Args> | |
void | Serialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
+template<typename Deserializer , typename DataType , typename... Args> | |
void | Deserialize (FairMQMessage &msg, DataType &&data, Args &&... args) const |
int | Send (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int | Receive (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
int64_t | Send (FairMQParts &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1) |
+auto | Transport () const -> FairMQTransportFactory * |
Getter for default transport factory. | |
+template<typename... Args> | |
FairMQMessagePtr | NewMessage (Args &&... args) |
+template<typename... Args> | |
FairMQMessagePtr | NewMessageFor (const std::string &channel, int index, Args &&... args) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessageFor (const std::string &channel, int index, const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessageFor (const std::string &channel, int index, const T &data) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel *> &channels) |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (fair::mq::ProgOptions &config) |
Assigns config to the device. | |
+fair::mq::ProgOptions * | GetConfig () const |
Get pointer to the config. | |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index)) |
+void | OnData (const std::string &channelName, InputMsgCallback callback) |
+template<typename T > | |
void | OnData (const std::string &channelName, bool(T::*memberFunction)(FairMQParts &parts, int index)) |
+void | OnData (const std::string &channelName, InputMultipartCallback callback) |
+FairMQChannel & | GetChannel (const std::string &channelName, const int index=0) |
+virtual void | RegisterChannelEndpoints () |
+bool | RegisterChannelEndpoint (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1) |
+void | PrintRegisteredChannels () |
+void | SetId (const std::string &id) |
+std::string | GetId () |
+const fair::mq::tools::Version | GetVersion () const |
+void | SetNumIoThreads (int numIoThreads) |
+int | GetNumIoThreads () const |
+void | SetNetworkInterface (const std::string &networkInterface) |
+std::string | GetNetworkInterface () const |
+void | SetDefaultTransport (const std::string &name) |
+std::string | GetDefaultTransport () const |
+void | SetInitTimeoutInS (int initTimeoutInS) |
+int | GetInitTimeoutInS () const |
void | SetTransport (const std::string &transport) |
+std::string | GetTransportName () const |
Gets the default transport name. | |
+void | SetRawCmdLineArgs (const std::vector< std::string > &args) |
+std::vector< std::string > | GetRawCmdLineArgs () const |
+void | RunStateMachine () |
template<typename Rep , typename Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &name, FairMQChannel &&channel) |
![]() | |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< fair::mq::ProgOptions > | fInternalConfig |
Internal program options configuration. | |
+fair::mq::ProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQTransportFactory, including all inherited members.
+CreateMessage()=0 | FairMQTransportFactory | pure virtual |
CreateMessage(const size_t size)=0 | FairMQTransportFactory | pure virtual |
CreateMessage(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr)=0 | FairMQTransportFactory | pure virtual |
CreateMessage(FairMQUnmanagedRegionPtr &unmanagedRegion, void *data, const size_t size, void *hint=0)=0 | FairMQTransportFactory | pure virtual |
CreatePoller(const std::vector< FairMQChannel > &channels) const =0 | FairMQTransportFactory | pure virtual |
CreatePoller(const std::vector< FairMQChannel *> &channels) const =0 | FairMQTransportFactory | pure virtual |
CreatePoller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const =0 | FairMQTransportFactory | pure virtual |
CreateSocket(const std::string &type, const std::string &name)=0 | FairMQTransportFactory | pure virtual |
CreateTransportFactory(const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const =0 | FairMQTransportFactory | pure virtual |
CreateUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const =0 | FairMQTransportFactory | pure virtual |
FairMQNoCleanup(void *, void *) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQSimpleMsgCleanup(void *, void *obj) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQTransportFactory(const std::string &id) | FairMQTransportFactory | |
GetId() const -> const std::string (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
GetMemoryResource() | FairMQTransportFactory | inline |
GetRegionInfo()=0 (defined in FairMQTransportFactory) | FairMQTransportFactory | pure virtual |
GetType() const =0 | FairMQTransportFactory | pure virtual |
Interrupt()=0 (defined in FairMQTransportFactory) | FairMQTransportFactory | pure virtual |
NewSimpleMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const char(&data)[N]) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator fair::mq::ChannelResource *() (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
Reset()=0 (defined in FairMQTransportFactory) | FairMQTransportFactory | pure virtual |
Resume()=0 (defined in FairMQTransportFactory) | FairMQTransportFactory | pure virtual |
SubscribeToRegionEvents(FairMQRegionEventCallback callback)=0 | FairMQTransportFactory | pure virtual |
UnsubscribeFromRegionEvents()=0 | FairMQTransportFactory | pure virtual |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
FairMQTransportFactory (const std::string &id) | |
+auto | GetId () const -> const std::string |
+fair::mq::ChannelResource * | GetMemoryResource () |
Get a pointer to the associated polymorphic memory resource. | |
+ | operator fair::mq::ChannelResource * () |
virtual FairMQMessagePtr | CreateMessage ()=0 |
Create empty FairMQMessage. More... | |
virtual FairMQMessagePtr | CreateMessage (const size_t size)=0 |
Create new FairMQMessage of specified size. More... | |
virtual FairMQMessagePtr | CreateMessage (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr)=0 |
Create new FairMQMessage with user provided buffer and size. More... | |
virtual FairMQMessagePtr | CreateMessage (FairMQUnmanagedRegionPtr &unmanagedRegion, void *data, const size_t size, void *hint=0)=0 |
create a message with the buffer located within the corresponding unmanaged region More... | |
+virtual FairMQSocketPtr | CreateSocket (const std::string &type, const std::string &name)=0 |
Create a socket. | |
+virtual FairMQPollerPtr | CreatePoller (const std::vector< FairMQChannel > &channels) const =0 |
Create a poller for a single channel (all subchannels) | |
+virtual FairMQPollerPtr | CreatePoller (const std::vector< FairMQChannel *> &channels) const =0 |
Create a poller for specific 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 specific channels (all subchannels) | |
virtual FairMQUnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const =0 |
Create new UnmanagedRegion. More... | |
virtual FairMQUnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const =0 |
Create new UnmanagedRegion. More... | |
virtual void | SubscribeToRegionEvents (FairMQRegionEventCallback callback)=0 |
Subscribe to region events (creation, destruction, ...) More... | |
+virtual void | UnsubscribeFromRegionEvents ()=0 |
Unsubscribe from region events. | |
+virtual std::vector< FairMQRegionInfo > | GetRegionInfo ()=0 |
+virtual fair::mq::Transport | GetType () const =0 |
Get transport type. | |
+virtual void | Interrupt ()=0 |
+virtual void | Resume ()=0 |
+virtual void | Reset ()=0 |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<std::size_t N> | |
FairMQMessagePtr | NewSimpleMessage (const char(&data)[N]) |
+FairMQMessagePtr | NewSimpleMessage (const std::string &str) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+FairMQMessagePtr | NewStaticMessage (const std::string &str) |
+Static Public Member Functions | |
+static auto | CreateTransportFactory (const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > |
+static void | FairMQNoCleanup (void *, void *) |
+template<typename T > | |
static void | FairMQSimpleMsgCleanup (void *, void *obj) |
FairMQTransportFactory::FairMQTransportFactory | +( | +const std::string & | +id | ) | ++ |
ctor
id | Topology wide unique id, usually the device id. |
+
|
+ +pure virtual | +
Create empty FairMQMessage.
+Implemented in fair::mq::shmem::TransportFactory, fair::mq::ofi::TransportFactory, FairMQTransportFactoryZMQ, and FairMQTransportFactoryNN.
+ +
+
|
+ +pure virtual | +
Create new FairMQMessage of specified size.
+size | message size |
Implemented in fair::mq::shmem::TransportFactory, FairMQTransportFactoryZMQ, and FairMQTransportFactoryNN.
+ +
+
|
+ +pure virtual | +
Create new FairMQMessage with user provided buffer and size.
+data | pointer to user provided buffer |
size | size of the user provided buffer |
ffn | callback, called when the message is transfered (and can be deleted) |
obj | optional helper pointer that can be used in the callback |
Implemented in fair::mq::shmem::TransportFactory, FairMQTransportFactoryZMQ, and FairMQTransportFactoryNN.
+ +
+
|
+ +pure virtual | +
create a message with the buffer located within the corresponding unmanaged region
+unmanagedRegion | the unmanaged region that this message buffer belongs to |
data | message buffer (must be within the region - checked at runtime by the transport) |
size | size of the message |
hint | optional parameter, returned to the user in the FairMQRegionCallback |
Implemented in fair::mq::shmem::TransportFactory, FairMQTransportFactoryZMQ, and FairMQTransportFactoryNN.
+ +
+
|
+ +pure virtual | +
Create new UnmanagedRegion.
+size | size of the region |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implemented in fair::mq::shmem::TransportFactory, fair::mq::ofi::TransportFactory, FairMQTransportFactoryZMQ, and FairMQTransportFactoryNN.
+ +
+
|
+ +pure virtual | +
Create new UnmanagedRegion.
+size | size of the region |
userFlags | flags to be stored with the region, have no effect on the transport, but can be retrieved from the region by the user |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implemented in fair::mq::shmem::TransportFactory, fair::mq::ofi::TransportFactory, FairMQTransportFactoryZMQ, and FairMQTransportFactoryNN.
+ +
+
|
+ +pure virtual | +
Subscribe to region events (creation, destruction, ...)
+callback | the callback that is called when a region event occurs |
Implemented in fair::mq::shmem::TransportFactory, fair::mq::ofi::TransportFactory, FairMQTransportFactoryZMQ, and FairMQTransportFactoryNN.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQTransportFactoryNN, including all inherited members.
+CreateMessage() override | FairMQTransportFactoryNN | virtual |
CreateMessage(const size_t size) override | FairMQTransportFactoryNN | virtual |
CreateMessage(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override | FairMQTransportFactoryNN | virtual |
CreateMessage(FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) override | FairMQTransportFactoryNN | virtual |
CreatePoller(const std::vector< FairMQChannel > &channels) const override | FairMQTransportFactoryNN | virtual |
CreatePoller(const std::vector< FairMQChannel *> &channels) const override | FairMQTransportFactoryNN | virtual |
CreatePoller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override | FairMQTransportFactoryNN | virtual |
CreateSocket(const std::string &type, const std::string &name) override | FairMQTransportFactoryNN | virtual |
CreateTransportFactory(const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) const override | FairMQTransportFactoryNN | virtual |
CreateUnmanagedRegion(const size_t size, int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const override | FairMQTransportFactoryNN | virtual |
FairMQNoCleanup(void *, void *) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQSimpleMsgCleanup(void *, void *obj) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQTransportFactory(const std::string &id) | FairMQTransportFactory | |
FairMQTransportFactoryNN(const std::string &id="", const fair::mq::ProgOptions *config=nullptr) (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN | |
GetId() const -> const std::string (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
GetMemoryResource() | FairMQTransportFactory | inline |
GetRegionInfo() override (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN | inlinevirtual |
GetType() const override | FairMQTransportFactoryNN | virtual |
Interrupt() override (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN | inlinevirtual |
NewSimpleMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const char(&data)[N]) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator fair::mq::ChannelResource *() (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
Reset() override (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN | virtual |
Resume() override (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN | inlinevirtual |
SubscribeToRegionEvents(FairMQRegionEventCallback) override | FairMQTransportFactoryNN | inlinevirtual |
UnsubscribeFromRegionEvents() override | FairMQTransportFactoryNN | inlinevirtual |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
~FairMQTransportFactoryNN() override (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQTransportFactoryNN (const std::string &id="", const fair::mq::ProgOptions *config=nullptr) |
FairMQMessagePtr | CreateMessage () override |
Create empty FairMQMessage. More... | |
FairMQMessagePtr | CreateMessage (const size_t size) override |
Create new FairMQMessage of specified size. More... | |
FairMQMessagePtr | CreateMessage (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override |
Create new FairMQMessage with user provided buffer and size. More... | |
FairMQMessagePtr | CreateMessage (FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) override |
create a message with the buffer located within the corresponding unmanaged region More... | |
+FairMQSocketPtr | CreateSocket (const std::string &type, const std::string &name) override |
Create a socket. | |
+FairMQPollerPtr | CreatePoller (const std::vector< FairMQChannel > &channels) const override |
Create a poller for a single channel (all subchannels) | |
+FairMQPollerPtr | CreatePoller (const std::vector< FairMQChannel *> &channels) const override |
Create a poller for specific channels. | |
+FairMQPollerPtr | CreatePoller (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override |
Create a poller for specific channels (all subchannels) | |
FairMQUnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) const override |
Create new UnmanagedRegion. More... | |
FairMQUnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const override |
Create new UnmanagedRegion. More... | |
void | SubscribeToRegionEvents (FairMQRegionEventCallback) override |
Subscribe to region events (creation, destruction, ...) More... | |
+void | UnsubscribeFromRegionEvents () override |
Unsubscribe from region events. | |
+std::vector< FairMQRegionInfo > | GetRegionInfo () override |
+fair::mq::Transport | GetType () const override |
Get transport type. | |
+void | Interrupt () override |
+void | Resume () override |
+void | Reset () override |
![]() | |
FairMQTransportFactory (const std::string &id) | |
+auto | GetId () const -> const std::string |
+fair::mq::ChannelResource * | GetMemoryResource () |
Get a pointer to the associated polymorphic memory resource. | |
+ | operator fair::mq::ChannelResource * () |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<std::size_t N> | |
FairMQMessagePtr | NewSimpleMessage (const char(&data)[N]) |
+FairMQMessagePtr | NewSimpleMessage (const std::string &str) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+FairMQMessagePtr | NewStaticMessage (const std::string &str) |
+Additional Inherited Members | |
![]() | |
+static auto | CreateTransportFactory (const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > |
+static void | FairMQNoCleanup (void *, void *) |
+template<typename T > | |
static void | FairMQSimpleMsgCleanup (void *, void *obj) |
+
|
+ +overridevirtual | +
Create empty FairMQMessage.
+Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new FairMQMessage of specified size.
+size | message size |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new FairMQMessage with user provided buffer and size.
+data | pointer to user provided buffer |
size | size of the user provided buffer |
ffn | callback, called when the message is transfered (and can be deleted) |
obj | optional helper pointer that can be used in the callback |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
create a message with the buffer located within the corresponding unmanaged region
+unmanagedRegion | the unmanaged region that this message buffer belongs to |
data | message buffer (must be within the region - checked at runtime by the transport) |
size | size of the message |
hint | optional parameter, returned to the user in the FairMQRegionCallback |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
userFlags | flags to be stored with the region, have no effect on the transport, but can be retrieved from the region by the user |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +inlineoverridevirtual | +
Subscribe to region events (creation, destruction, ...)
+callback | the callback that is called when a region event occurs |
Implements FairMQTransportFactory.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQTransportFactoryZMQ, including all inherited members.
+CreateMessage() override | FairMQTransportFactoryZMQ | virtual |
CreateMessage(const size_t size) override | FairMQTransportFactoryZMQ | virtual |
CreateMessage(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override | FairMQTransportFactoryZMQ | virtual |
CreateMessage(FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) override | FairMQTransportFactoryZMQ | virtual |
CreatePoller(const std::vector< FairMQChannel > &channels) const override | FairMQTransportFactoryZMQ | virtual |
CreatePoller(const std::vector< FairMQChannel *> &channels) const override | FairMQTransportFactoryZMQ | virtual |
CreatePoller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override | FairMQTransportFactoryZMQ | virtual |
CreateSocket(const std::string &type, const std::string &name) override | FairMQTransportFactoryZMQ | virtual |
CreateTransportFactory(const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) const override | FairMQTransportFactoryZMQ | virtual |
CreateUnmanagedRegion(const size_t size, int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const override | FairMQTransportFactoryZMQ | virtual |
FairMQNoCleanup(void *, void *) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQSimpleMsgCleanup(void *, void *obj) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQTransportFactory(const std::string &id) | FairMQTransportFactory | |
FairMQTransportFactoryZMQ(const std::string &id="", const fair::mq::ProgOptions *config=nullptr) (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ | |
FairMQTransportFactoryZMQ(const FairMQTransportFactoryZMQ &)=delete (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ | |
GetId() const -> const std::string (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
GetMemoryResource() | FairMQTransportFactory | inline |
GetRegionInfo() override (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ | inlinevirtual |
GetType() const override | FairMQTransportFactoryZMQ | virtual |
Interrupt() override (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ | inlinevirtual |
NewSimpleMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const char(&data)[N]) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator fair::mq::ChannelResource *() (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator=(const FairMQTransportFactoryZMQ &)=delete (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ | |
Reset() override (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ | inlinevirtual |
Resume() override (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ | inlinevirtual |
SubscribeToRegionEvents(FairMQRegionEventCallback) override | FairMQTransportFactoryZMQ | inlinevirtual |
UnsubscribeFromRegionEvents() override | FairMQTransportFactoryZMQ | inlinevirtual |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
~FairMQTransportFactoryZMQ() override (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <FairMQTransportFactoryZMQ.h>
+Public Member Functions | |
+ | FairMQTransportFactoryZMQ (const std::string &id="", const fair::mq::ProgOptions *config=nullptr) |
+ | FairMQTransportFactoryZMQ (const FairMQTransportFactoryZMQ &)=delete |
+FairMQTransportFactoryZMQ | operator= (const FairMQTransportFactoryZMQ &)=delete |
FairMQMessagePtr | CreateMessage () override |
Create empty FairMQMessage. More... | |
FairMQMessagePtr | CreateMessage (const size_t size) override |
Create new FairMQMessage of specified size. More... | |
FairMQMessagePtr | CreateMessage (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override |
Create new FairMQMessage with user provided buffer and size. More... | |
FairMQMessagePtr | CreateMessage (FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) override |
create a message with the buffer located within the corresponding unmanaged region More... | |
+FairMQSocketPtr | CreateSocket (const std::string &type, const std::string &name) override |
Create a socket. | |
+FairMQPollerPtr | CreatePoller (const std::vector< FairMQChannel > &channels) const override |
Create a poller for a single channel (all subchannels) | |
+FairMQPollerPtr | CreatePoller (const std::vector< FairMQChannel *> &channels) const override |
Create a poller for specific channels. | |
+FairMQPollerPtr | CreatePoller (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override |
Create a poller for specific channels (all subchannels) | |
FairMQUnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) const override |
Create new UnmanagedRegion. More... | |
FairMQUnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const override |
Create new UnmanagedRegion. More... | |
void | SubscribeToRegionEvents (FairMQRegionEventCallback) override |
Subscribe to region events (creation, destruction, ...) More... | |
+void | UnsubscribeFromRegionEvents () override |
Unsubscribe from region events. | |
+std::vector< FairMQRegionInfo > | GetRegionInfo () override |
+fair::mq::Transport | GetType () const override |
Get transport type. | |
+void | Interrupt () override |
+void | Resume () override |
+void | Reset () override |
![]() | |
FairMQTransportFactory (const std::string &id) | |
+auto | GetId () const -> const std::string |
+fair::mq::ChannelResource * | GetMemoryResource () |
Get a pointer to the associated polymorphic memory resource. | |
+ | operator fair::mq::ChannelResource * () |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<std::size_t N> | |
FairMQMessagePtr | NewSimpleMessage (const char(&data)[N]) |
+FairMQMessagePtr | NewSimpleMessage (const std::string &str) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+FairMQMessagePtr | NewStaticMessage (const std::string &str) |
+Additional Inherited Members | |
![]() | |
+static auto | CreateTransportFactory (const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > |
+static void | FairMQNoCleanup (void *, void *) |
+template<typename T > | |
static void | FairMQSimpleMsgCleanup (void *, void *obj) |
+
|
+ +overridevirtual | +
Create empty FairMQMessage.
+Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new FairMQMessage of specified size.
+size | message size |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new FairMQMessage with user provided buffer and size.
+data | pointer to user provided buffer |
size | size of the user provided buffer |
ffn | callback, called when the message is transfered (and can be deleted) |
obj | optional helper pointer that can be used in the callback |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
create a message with the buffer located within the corresponding unmanaged region
+unmanagedRegion | the unmanaged region that this message buffer belongs to |
data | message buffer (must be within the region - checked at runtime by the transport) |
size | size of the message |
hint | optional parameter, returned to the user in the FairMQRegionCallback |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
userFlags | flags to be stored with the region, have no effect on the transport, but can be retrieved from the region by the user |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +inlineoverridevirtual | +
Subscribe to region events (creation, destruction, ...)
+callback | the callback that is called when a region event occurs |
Implements FairMQTransportFactory.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQUnmanagedRegion, including all inherited members.
+GetData() const =0 (defined in FairMQUnmanagedRegion) | FairMQUnmanagedRegion | pure virtual |
GetSize() const =0 (defined in FairMQUnmanagedRegion) | FairMQUnmanagedRegion | pure virtual |
~FairMQUnmanagedRegion() (defined in FairMQUnmanagedRegion) | FairMQUnmanagedRegion | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+virtual void * | GetData () const =0 |
+virtual size_t | GetSize () const =0 |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQUnmanagedRegionNN, including all inherited members.
+FairMQSocketNN (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | friend |
FairMQUnmanagedRegionNN(const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | |
FairMQUnmanagedRegionNN(const size_t size, const int64_t userFlags, FairMQRegionCallback callback, const std::string &path="", int flags=0) (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | |
FairMQUnmanagedRegionNN(const FairMQUnmanagedRegionNN &)=delete (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | |
GetData() const override (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | virtual |
GetSize() const override (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | virtual |
operator=(const FairMQUnmanagedRegionNN &)=delete (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | |
~FairMQUnmanagedRegion() (defined in FairMQUnmanagedRegion) | FairMQUnmanagedRegion | inlinevirtual |
~FairMQUnmanagedRegionNN() (defined in FairMQUnmanagedRegionNN) | FairMQUnmanagedRegionNN | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQUnmanagedRegionNN (const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) |
+ | FairMQUnmanagedRegionNN (const size_t size, const int64_t userFlags, FairMQRegionCallback callback, const std::string &path="", int flags=0) |
+ | FairMQUnmanagedRegionNN (const FairMQUnmanagedRegionNN &)=delete |
+FairMQUnmanagedRegionNN | operator= (const FairMQUnmanagedRegionNN &)=delete |
+virtual void * | GetData () const override |
+virtual size_t | GetSize () const override |
+Friends | |
+class | FairMQSocketNN |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for FairMQUnmanagedRegionZMQ, including all inherited members.
+FairMQMessageZMQ (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | friend |
FairMQSocketZMQ (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | friend |
FairMQUnmanagedRegionZMQ(const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | |
FairMQUnmanagedRegionZMQ(const size_t size, const int64_t userFlags, FairMQRegionCallback callback, const std::string &path="", int flags=0) (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | |
FairMQUnmanagedRegionZMQ(const FairMQUnmanagedRegionZMQ &)=delete (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | |
GetData() const override (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | virtual |
GetSize() const override (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | virtual |
operator=(const FairMQUnmanagedRegionZMQ &)=delete (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | |
~FairMQUnmanagedRegion() (defined in FairMQUnmanagedRegion) | FairMQUnmanagedRegion | inlinevirtual |
~FairMQUnmanagedRegionZMQ() (defined in FairMQUnmanagedRegionZMQ) | FairMQUnmanagedRegionZMQ | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | FairMQUnmanagedRegionZMQ (const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) |
+ | FairMQUnmanagedRegionZMQ (const size_t size, const int64_t userFlags, FairMQRegionCallback callback, const std::string &path="", int flags=0) |
+ | FairMQUnmanagedRegionZMQ (const FairMQUnmanagedRegionZMQ &)=delete |
+FairMQUnmanagedRegionZMQ | operator= (const FairMQUnmanagedRegionZMQ &)=delete |
+virtual void * | GetData () const override |
+virtual size_t | GetSize () const override |
+Friends | |
+class | FairMQSocketZMQ |
+class | FairMQMessageZMQ |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for LinePrinter, including all inherited members.
+LinePrinter(stringstream &out, string prefix) (defined in LinePrinter) | LinePrinter | inline |
Print(const string &line) (defined in LinePrinter) | LinePrinter | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | LinePrinter (stringstream &out, string prefix) |
+void | Print (const string &line) |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::ChannelResource, including all inherited members.
+ChannelResource()=delete (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | |
ChannelResource(FairMQTransportFactory *_factory) (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | inline |
do_allocate(std::size_t bytes, std::size_t alignment) override | fair::mq::ChannelResource | protected |
do_deallocate(void *p, std::size_t, std::size_t) override (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | inlineprotected |
do_is_equal(const pmr::memory_resource &other) const noexcept override (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | inlineprotected |
factory (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | protected |
getMessage(void *p) override | fair::mq::ChannelResource | inlinevirtual |
getNumberOfMessages() const noexcept override (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | inlinevirtual |
getTransportFactory() noexcept override (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | inlinevirtual |
messageMap (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | protected |
setMessage(FairMQMessagePtr message) override (defined in fair::mq::ChannelResource) | fair::mq::ChannelResource | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <MemoryResources.h>
+Public Member Functions | |
+ | ChannelResource (FairMQTransportFactory *_factory) |
FairMQMessagePtr | getMessage (void *p) override |
+void * | setMessage (FairMQMessagePtr message) override |
+FairMQTransportFactory * | getTransportFactory () noexcept override |
+size_t | getNumberOfMessages () const noexcept override |
+Protected Member Functions | |
void * | do_allocate (std::size_t bytes, std::size_t alignment) override |
Memory allocators and interfaces related to managing memory via the trasport layer. More... | |
+void | do_deallocate (void *p, std::size_t, std::size_t) override |
+bool | do_is_equal (const pmr::memory_resource &other) const noexcept override |
+Protected Attributes | |
+FairMQTransportFactory * | factory {nullptr} |
+boost::container::flat_map< void *, FairMQMessagePtr > | messageMap |
This is the allocator that interfaces to FairMQ memory management. All allocations are delegated to FairMQ so standard (e.g. STL) containers can construct their stuff in memory regions appropriate for the data channel configuration.
+
+
|
+ +overrideprotected | +
Memory allocators and interfaces related to managing memory via the trasport layer.
+ + +
+
|
+ +inlineoverridevirtual | +
return the message containing data associated with the pointer (to start of buffer), e.g. pointer returned by std::vector::data() return nullptr if returning a message does not make sense!
+ +Implements fair::mq::FairMQMemoryResource.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::DeviceRunner, including all inherited members.
+AddHook(std::function< void(DeviceRunner &)> hook) -> void (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | inline |
DeviceRunner(int argc, char *const *argv, bool printLogo=true) (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
fConfig (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
fDevice (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
fPluginManager (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
fPrintLogo (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
fRawCmdLineArgs (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
HandleGeneralOptions(const fair::mq::ProgOptions &config, bool printLogo=true) (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | static |
RemoveHook() -> void (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | inline |
Run() -> int (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
RunWithExceptionHandlers() -> int (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
SubscribeForConfigChange() (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner | |
UnsubscribeFromConfigChange() (defined in fair::mq::DeviceRunner) | fair::mq::DeviceRunner |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Utility class to facilitate a convenient top-level device launch/shutdown. + More...
+ +#include <fairmq/DeviceRunner.h>
+Public Member Functions | |
+ | DeviceRunner (int argc, char *const *argv, bool printLogo=true) |
+auto | Run () -> int |
+auto | RunWithExceptionHandlers () -> int |
+void | SubscribeForConfigChange () |
+void | UnsubscribeFromConfigChange () |
+template<typename H > | |
auto | AddHook (std::function< void(DeviceRunner &)> hook) -> void |
+template<typename H > | |
auto | RemoveHook () -> void |
+Static Public Member Functions | |
+static bool | HandleGeneralOptions (const fair::mq::ProgOptions &config, bool printLogo=true) |
+Public Attributes | |
+std::vector< std::string > | fRawCmdLineArgs |
+fair::mq::ProgOptions | fConfig |
+std::unique_ptr< FairMQDevice > | fDevice |
+PluginManager | fPluginManager |
+const bool | fPrintLogo |
Utility class to facilitate a convenient top-level device launch/shutdown.
+Runs a single FairMQ device with config and plugin support.
+For customization user hooks are executed at various steps during device launch/shutdown in the following sequence:
LoadPlugins + | + v +
SetCustomCmdLineOptions | v ModifyRawCmdLineArgs | v InstatiateDevice
+Each hook has access to all members of the DeviceRunner and really only differs by the point in time it is called.
+For an example usage of this class see the fairmq/runFairMQDevice.h header.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::EventManager, including all inherited members.
+Emit(typename E::KeyType key, Args... args) const -> void (defined in fair::mq::EventManager) | fair::mq::EventManager | inline |
Signal typedef (defined in fair::mq::EventManager) | fair::mq::EventManager | |
Subscribe(const std::string &subscriber, std::function< void(typename E::KeyType, Args...)> callback) -> void (defined in fair::mq::EventManager) | fair::mq::EventManager | inline |
Unsubscribe(const std::string &subscriber) -> void (defined in fair::mq::EventManager) | fair::mq::EventManager | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Manages event callbacks from different subscribers. + More...
+ +#include <fairmq/EventManager.h>
+Public Types | |
+template<typename E , typename ... Args> | |
using | Signal = boost::signals2::signal< void(typename E::KeyType, Args...)> |
+Public Member Functions | |
+template<typename E , typename ... Args> | |
auto | Subscribe (const std::string &subscriber, std::function< void(typename E::KeyType, Args...)> callback) -> void |
+template<typename E , typename ... Args> | |
auto | Unsubscribe (const std::string &subscriber) -> void |
+template<typename E , typename ... Args> | |
auto | Emit (typename E::KeyType key, Args... args) const -> void |
Manages event callbacks from different subscribers.
+The event manager stores a set of callbacks and associates them with events depending on the callback signature. The first callback argument must be of a special key type determined by the event type.
+Callbacks can be subscribed/unsubscribed based on a subscriber id, the event type, and the callback signature.
+Events can be emitted based on event type and callback signature.
+The event manager is thread-safe.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::FairMQMemoryResource, including all inherited members.
+getMessage(void *p)=0 | fair::mq::FairMQMemoryResource | pure virtual |
getNumberOfMessages() const noexcept=0 (defined in fair::mq::FairMQMemoryResource) | fair::mq::FairMQMemoryResource | pure virtual |
getTransportFactory() noexcept=0 (defined in fair::mq::FairMQMemoryResource) | fair::mq::FairMQMemoryResource | pure virtual |
setMessage(FairMQMessagePtr)=0 (defined in fair::mq::FairMQMemoryResource) | fair::mq::FairMQMemoryResource | pure virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <MemoryResources.h>
+Public Member Functions | |
virtual FairMQMessagePtr | getMessage (void *p)=0 |
+virtual void * | setMessage (FairMQMessagePtr)=0 |
+virtual FairMQTransportFactory * | getTransportFactory () noexcept=0 |
+virtual size_t | getNumberOfMessages () const noexcept=0 |
All FairMQ related memory resources need to inherit from this interface class for the getMessage() api.
+
+
|
+ +pure virtual | +
return the message containing data associated with the pointer (to start of buffer), e.g. pointer returned by std::vector::data() return nullptr if returning a message does not make sense!
+ +Implemented in fair::mq::ChannelResource.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::Plugin, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> bool (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeleteProperty(const std::string &key) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeviceState typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
DeviceStateTransition typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
GetChannelInfo() const -> std::unordered_map< std::string, int > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetCurrentDeviceState() const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetHomepage() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetMaintainer() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetName() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperties(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsString(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsStringStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key, const T &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyKeys() const -> std::vector< std::string > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetVersion() const -> const Version (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
NoProgramOptions() -> ProgOptions (defined in fair::mq::Plugin) | fair::mq::Plugin | inlinestatic |
operator!= (defined in fair::mq::Plugin) | fair::mq::Plugin | friend |
operator<< (defined in fair::mq::Plugin) | fair::mq::Plugin | friend |
operator=(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
operator== (defined in fair::mq::Plugin) | fair::mq::Plugin | friend |
Plugin()=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
ProgOptions typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
PropertyExists(const std::string &key) -> int (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ReleaseDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperties(const fair::mq::Properties &props) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperty(const std::string &key, T val) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
StealDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToDeviceStateChange(std::function< void(DeviceState)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChange(std::function< void(const std::string &key, T newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChangeAsString(std::function< void(const std::string &key, std::string newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
TakeDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceState(const std::string &state) const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceStateTransition(const std::string &transition) const -> DeviceStateTransition (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceState state) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceStateTransition transition) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromDeviceStateChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChangeAsString() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperties(const fair::mq::Properties &input) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperty(const std::string &key, T val) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
Version typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
~Plugin() (defined in fair::mq::Plugin) | fair::mq::Plugin | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Base class for FairMQ plugins. + More...
+ +#include <fairmq/Plugin.h>
+Public Types | |
+using | ProgOptions = boost::optional< boost::program_options::options_description > |
+using | Version = tools::Version |
+using | DeviceState = fair::mq::PluginServices::DeviceState |
+using | DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransition |
+Public Member Functions | |
+ | Plugin (std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) |
+ | Plugin (const Plugin &)=delete |
+Plugin | operator= (const Plugin &)=delete |
+auto | GetName () const -> const std::string & |
+auto | GetVersion () const -> const Version |
+auto | GetMaintainer () const -> const std::string & |
+auto | GetHomepage () const -> const std::string & |
+auto | ToDeviceState (const std::string &state) const -> DeviceState |
+auto | ToDeviceStateTransition (const std::string &transition) const -> DeviceStateTransition |
+auto | ToStr (DeviceState state) const -> std::string |
+auto | ToStr (DeviceStateTransition transition) const -> std::string |
+auto | GetCurrentDeviceState () const -> DeviceState |
+auto | TakeDeviceControl () -> void |
+auto | StealDeviceControl () -> void |
+auto | ReleaseDeviceControl () -> void |
+auto | ChangeDeviceState (const DeviceStateTransition next) -> bool |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
T | GetProperty (const std::string &key) const |
+template<typename T > | |
T | GetProperty (const std::string &key, const T &ifNotFound) const |
+std::string | GetPropertyAsString (const std::string &key) const |
+std::string | GetPropertyAsString (const std::string &key, const std::string &ifNotFound) const |
+fair::mq::Properties | GetProperties (const std::string &q) const |
+fair::mq::Properties | GetPropertiesStartingWith (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsString (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsStringStartingWith (const std::string &q) const |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+void | SetProperties (const fair::mq::Properties &props) |
+template<typename T > | |
bool | UpdateProperty (const std::string &key, T val) |
+bool | UpdateProperties (const fair::mq::Properties &input) |
+void | DeleteProperty (const std::string &key) |
+template<typename T > | |
auto | SubscribeToPropertyChange (std::function< void(const std::string &key, T newValue)> callback) -> void |
+template<typename T > | |
auto | UnsubscribeFromPropertyChange () -> void |
+auto | SubscribeToPropertyChangeAsString (std::function< void(const std::string &key, std::string newValue)> callback) -> void |
+auto | UnsubscribeFromPropertyChangeAsString () -> void |
+auto | CycleLogConsoleSeverityUp () -> void |
+auto | CycleLogConsoleSeverityDown () -> void |
+auto | CycleLogVerbosityUp () -> void |
+auto | CycleLogVerbosityDown () -> void |
+Static Public Member Functions | |
+static auto | NoProgramOptions () -> ProgOptions |
+Friends | |
+auto | operator== (const Plugin &lhs, const Plugin &rhs) -> bool |
+auto | operator!= (const Plugin &lhs, const Plugin &rhs) -> bool |
+auto | operator<< (std::ostream &os, const Plugin &p) -> std::ostream & |
Base class for FairMQ plugins.
+The plugin base class encapsulates the plugin metadata.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::PluginManager, including all inherited members.
+AppendSearchPath(const boost::filesystem::path &) -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
EmplacePluginServices(Args &&... args) -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inline |
ForEachPlugin(std::function< void(Plugin &)> func) -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inline |
ForEachPluginProgOptions(std::function< void(boost::program_options::options_description)> func) const -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inline |
InstantiatePlugins() -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
LibPrefix() -> const std::string & (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inlinestatic |
LoadPlugin(const std::string &pluginName) -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
LoadPlugins(const std::vector< std::string > &pluginNames) -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inline |
PluginFactory typedef (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
PluginManager() (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
PluginManager(const std::vector< std::string > args) (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
PrependSearchPath(const boost::filesystem::path &) -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
ProgramOptions() -> boost::program_options::options_description (defined in fair::mq::PluginManager) | fair::mq::PluginManager | static |
SearchPaths() const -> const std::vector< boost::filesystem::path > & (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inline |
SetSearchPaths(const std::vector< boost::filesystem::path > &) -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | |
WaitForPluginsToReleaseDeviceControl() -> void (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inline |
~PluginManager() (defined in fair::mq::PluginManager) | fair::mq::PluginManager | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
manages and owns plugin instances + More...
+ +#include <fairmq/PluginManager.h>
+Classes | |
struct | BadSearchPath |
struct | PluginInstantiationError |
struct | PluginLoadError |
struct | ProgramOptionsParseError |
+Public Types | |
+using | PluginFactory = std::unique_ptr< fair::mq::Plugin >(PluginServices &) |
+Public Member Functions | |
+ | PluginManager (const std::vector< std::string > args) |
+auto | SetSearchPaths (const std::vector< boost::filesystem::path > &) -> void |
+auto | AppendSearchPath (const boost::filesystem::path &) -> void |
+auto | PrependSearchPath (const boost::filesystem::path &) -> void |
+auto | SearchPaths () const -> const std::vector< boost::filesystem::path > & |
+auto | LoadPlugin (const std::string &pluginName) -> void |
+auto | LoadPlugins (const std::vector< std::string > &pluginNames) -> void |
+auto | InstantiatePlugins () -> void |
+auto | ForEachPlugin (std::function< void(Plugin &)> func) -> void |
+auto | ForEachPluginProgOptions (std::function< void(boost::program_options::options_description)> func) const -> void |
+template<typename... Args> | |
auto | EmplacePluginServices (Args &&... args) -> void |
+auto | WaitForPluginsToReleaseDeviceControl () -> void |
+Static Public Member Functions | |
+static auto | ProgramOptions () -> boost::program_options::options_description |
+static auto | LibPrefix () -> const std::string & |
manages and owns plugin instances
+The plugin manager is responsible for the whole plugin lifecycle. It facilitates two plugin mechanisms: A prelinked dynamic plugins (shared libraries) B dynamic plugins (shared libraries) C static plugins (builtin)
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::PluginServices, including all inherited members.
+ChangeDeviceState(const std::string &controller, const DeviceStateTransition next) -> bool | fair::mq::PluginServices | |
CycleLogConsoleSeverityDown() -> void | fair::mq::PluginServices | inline |
CycleLogConsoleSeverityUp() -> void | fair::mq::PluginServices | inline |
CycleLogVerbosityDown() -> void | fair::mq::PluginServices | inline |
CycleLogVerbosityUp() -> void | fair::mq::PluginServices | inline |
DeleteProperty(const std::string &key) | fair::mq::PluginServices | inline |
DeviceState typedef (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
DeviceStateTransition typedef (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
GetChannelInfo() const -> std::unordered_map< std::string, int > | fair::mq::PluginServices | inline |
GetCurrentDeviceState() const -> DeviceState | fair::mq::PluginServices | inline |
GetDeviceController() const -> boost::optional< std::string > | fair::mq::PluginServices | |
GetProperties(const std::string &q) const | fair::mq::PluginServices | inline |
GetPropertiesAsString(const std::string &q) const | fair::mq::PluginServices | inline |
GetPropertiesAsStringStartingWith(const std::string &q) const | fair::mq::PluginServices | inline |
GetPropertiesStartingWith(const std::string &q) const | fair::mq::PluginServices | inline |
GetProperty(const std::string &key) const -> T | fair::mq::PluginServices | inline |
GetProperty(const std::string &key, const T &ifNotFound) const | fair::mq::PluginServices | inline |
GetPropertyAsString(const std::string &key) const -> std::string | fair::mq::PluginServices | inline |
GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const -> std::string | fair::mq::PluginServices | inline |
GetPropertyKeys() const -> std::vector< std::string > | fair::mq::PluginServices | inline |
operator=(const PluginServices &)=delete (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
PluginServices()=delete (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
PluginServices(ProgOptions &config, FairMQDevice &device) (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
PluginServices(const PluginServices &)=delete (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
PropertyExists(const std::string &key) const -> bool | fair::mq::PluginServices | inline |
ReleaseDeviceControl(const std::string &controller) -> void | fair::mq::PluginServices | |
SetProperties(const fair::mq::Properties &props) | fair::mq::PluginServices | inline |
SetProperty(const std::string &key, T val) -> void | fair::mq::PluginServices | inline |
StealDeviceControl(const std::string &controller) -> void | fair::mq::PluginServices | |
SubscribeToDeviceStateChange(const std::string &subscriber, std::function< void(DeviceState)> callback) -> void | fair::mq::PluginServices | inline |
SubscribeToPropertyChange(const std::string &subscriber, std::function< void(const std::string &key, T)> callback) const -> void | fair::mq::PluginServices | inline |
SubscribeToPropertyChangeAsString(const std::string &subscriber, std::function< void(const std::string &key, std::string)> callback) const -> void | fair::mq::PluginServices | inline |
TakeDeviceControl(const std::string &controller) -> void | fair::mq::PluginServices | |
ToDeviceState(const std::string &state) -> DeviceState | fair::mq::PluginServices | inlinestatic |
ToDeviceStateTransition(const std::string &transition) -> DeviceStateTransition | fair::mq::PluginServices | inlinestatic |
ToStr(DeviceState state) -> std::string | fair::mq::PluginServices | inlinestatic |
ToStr(DeviceStateTransition transition) -> std::string | fair::mq::PluginServices | inlinestatic |
UnsubscribeFromDeviceStateChange(const std::string &subscriber) -> void | fair::mq::PluginServices | inline |
UnsubscribeFromPropertyChange(const std::string &subscriber) -> void | fair::mq::PluginServices | inline |
UnsubscribeFromPropertyChangeAsString(const std::string &subscriber) -> void | fair::mq::PluginServices | inline |
UpdateProperties(const fair::mq::Properties &input) | fair::mq::PluginServices | inline |
UpdateProperty(const std::string &key, T val) | fair::mq::PluginServices | inline |
WaitForReleaseDeviceControl() -> void | fair::mq::PluginServices | |
~PluginServices() (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Facilitates communication between devices and plugins. + More...
+ +#include <fairmq/PluginServices.h>
+Classes | |
struct | DeviceControlError |
+Public Types | |
+using | DeviceState = fair::mq::State |
+using | DeviceStateTransition = fair::mq::Transition |
+Public Member Functions | |
+ | PluginServices (ProgOptions &config, FairMQDevice &device) |
+ | PluginServices (const PluginServices &)=delete |
+PluginServices | operator= (const PluginServices &)=delete |
auto | GetCurrentDeviceState () const -> DeviceState |
auto | TakeDeviceControl (const std::string &controller) -> void |
Become device controller. More... | |
auto | StealDeviceControl (const std::string &controller) -> void |
Become device controller by force. More... | |
auto | ReleaseDeviceControl (const std::string &controller) -> void |
Release device controller role. More... | |
+auto | GetDeviceController () const -> boost::optional< std::string > |
Get current device controller. | |
+auto | WaitForReleaseDeviceControl () -> void |
Block until control is released. | |
auto | ChangeDeviceState (const std::string &controller, const DeviceStateTransition next) -> bool |
Request a device state transition. More... | |
auto | SubscribeToDeviceStateChange (const std::string &subscriber, std::function< void(DeviceState)> callback) -> void |
Subscribe with a callback to device state changes. More... | |
auto | UnsubscribeFromDeviceStateChange (const std::string &subscriber) -> void |
Unsubscribe from device state changes. More... | |
auto | PropertyExists (const std::string &key) const -> bool |
Checks a property with the given key exist in the configuration. More... | |
template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
Set config property. More... | |
void | SetProperties (const fair::mq::Properties &props) |
Set multiple config properties. More... | |
template<typename T > | |
bool | UpdateProperty (const std::string &key, T val) |
Updates an existing config property (or fails if it doesn't exist) More... | |
bool | UpdateProperties (const fair::mq::Properties &input) |
Updates multiple existing config properties (or fails of any of then do not exist, leaving property store unchanged) More... | |
void | DeleteProperty (const std::string &key) |
Deletes a property with the given key from the config store. More... | |
template<typename T > | |
auto | GetProperty (const std::string &key) const -> T |
Read config property, throw if no property with this key exists. More... | |
template<typename T > | |
T | GetProperty (const std::string &key, const T &ifNotFound) const |
Read config property, return provided value if no property with this key exists. More... | |
auto | GetPropertyAsString (const std::string &key) const -> std::string |
Read config property as string, throw if no property with this key exists. More... | |
auto | GetPropertyAsString (const std::string &key, const std::string &ifNotFound) const -> std::string |
Read config property, return provided value if no property with this key exists. More... | |
fair::mq::Properties | GetProperties (const std::string &q) const |
Read several config properties whose keys match the provided regular expression. More... | |
fair::mq::Properties | GetPropertiesStartingWith (const std::string &q) const |
Read several config properties whose keys start with the provided string. More... | |
std::map< std::string, std::string > | GetPropertiesAsString (const std::string &q) const |
Read several config properties as string whose keys match the provided regular expression. More... | |
std::map< std::string, std::string > | GetPropertiesAsStringStartingWith (const std::string &q) const |
Read several config properties as string whose keys start with the provided string. More... | |
auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
Retrieve current channel information. More... | |
auto | GetPropertyKeys () const -> std::vector< std::string > |
Discover the list of property keys. More... | |
template<typename T > | |
auto | SubscribeToPropertyChange (const std::string &subscriber, std::function< void(const std::string &key, T)> callback) const -> void |
Subscribe to property updates of type T. More... | |
template<typename T > | |
auto | UnsubscribeFromPropertyChange (const std::string &subscriber) -> void |
Unsubscribe from property updates of type T. More... | |
auto | SubscribeToPropertyChangeAsString (const std::string &subscriber, std::function< void(const std::string &key, std::string)> callback) const -> void |
Subscribe to property updates. More... | |
auto | UnsubscribeFromPropertyChangeAsString (const std::string &subscriber) -> void |
Unsubscribe from property updates that convert to string. More... | |
+auto | CycleLogConsoleSeverityUp () -> void |
Increases console logging severity, or sets it to lowest if it is already highest. | |
+auto | CycleLogConsoleSeverityDown () -> void |
Decreases console logging severity, or sets it to highest if it is already lowest. | |
+auto | CycleLogVerbosityUp () -> void |
Increases logging verbosity, or sets it to lowest if it is already highest. | |
+auto | CycleLogVerbosityDown () -> void |
Decreases logging verbosity, or sets it to highest if it is already lowest. | |
+Static Public Member Functions | |
static auto | ToDeviceState (const std::string &state) -> DeviceState |
Convert string to DeviceState. More... | |
static auto | ToDeviceStateTransition (const std::string &transition) -> DeviceStateTransition |
Convert string to DeviceStateTransition. More... | |
static auto | ToStr (DeviceState state) -> std::string |
Convert DeviceState to string. More... | |
static auto | ToStr (DeviceStateTransition transition) -> std::string |
Convert DeviceStateTransition to string. More... | |
Facilitates communication between devices and plugins.
+auto PluginServices::ChangeDeviceState | +( | +const std::string & | +controller, | +
+ | + | const DeviceStateTransition | +next | +
+ | ) | +-> bool | +
Request a device state transition.
+controller | id |
next | state transition |
fair::mq::PluginServices::DeviceControlError | if control role is not currently owned by passed controller id. |
The state transition may not happen immediately, but when the current state evaluates the pending transition event and terminates. In other words, the device states are scheduled cooperatively. If the device control role has not been taken yet, calling this function will take over control implicitely.
+ +
+
|
+ +inline | +
Deletes a property with the given key from the config store.
+key |
+
|
+ +inline | +
Retrieve current channel information.
+
+
|
+ +inline | +
+
|
+ +inline | +
Read several config properties whose keys match the provided regular expression.
+q | regex string to match for |
+
|
+ +inline | +
Read several config properties as string whose keys match the provided regular expression.
+q | regex string to match for |
+
|
+ +inline | +
Read several config properties as string whose keys start with the provided string.
+q | string to match for |
Typically more performant than GetPropertiesAsString with regex
+ +
+
|
+ +inline | +
Read several config properties whose keys start with the provided string.
+q | string to match for |
Typically more performant than GetProperties with regex
+ +
+
|
+ +inline | +
Read config property, throw if no property with this key exists.
+key |
+
|
+ +inline | +
Read config property, return provided value if no property with this key exists.
+key | |
ifNotFound | value to return if key is not found |
+
|
+ +inline | +
Read config property as string, throw if no property with this key exists.
+key |
Supports conversion to string for a fixed set of types, for custom/unsupported types add them via fair::mq::PropertyHelper::AddType<MyType>("optional label")
the provided type must then be convertible to string via operator<<
+
|
+ +inline | +
Read config property, return provided value if no property with this key exists.
+key | |
ifNotFound | value to return if key is not found |
Supports conversion to string for a fixed set of types, for custom/unsupported types add them via fair::mq::PropertyHelper::AddType<MyType>("optional label")
the provided type must then be convertible to string via operator<<
+
|
+ +inline | +
Discover the list of property keys.
+
+
|
+ +inline | +
Checks a property with the given key exist in the configuration.
+key |
auto PluginServices::ReleaseDeviceControl | +( | +const std::string & | +controller | ) | +-> void | +
Release device controller role.
+controller | id |
fair::mq::PluginServices::DeviceControlError | if passed controller id is not the current device controller. |
+
|
+ +inline | +
Set multiple config properties.
+props | fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any |
+
|
+ +inline | +
Set config property.
+key | |
val | Setting a config property will store the value in the FairMQ internal config store and notify any subscribers about the update. It is property dependent, if the call to this method will have an immediate, delayed or any effect at all. |
auto PluginServices::StealDeviceControl | +( | +const std::string & | +controller | ) | +-> void | +
Become device controller by force.
+controller | id |
Take over device controller privileges by force. Does not trigger the ReleaseDeviceControl condition! This function is intended to implement override/emergency control functionality (e.g. device shutdown on SIGINT).
+ +
+
|
+ +inline | +
Subscribe with a callback to device state changes.
+subscriber | id |
callback | The callback will be called at the beginning of a new state. The callback is called from the thread the state is running in. |
+
|
+ +inline | +
Subscribe to property updates of type T.
+subscriber | |
callback | function |
Subscribe to property changes with a callback to monitor property changes in an event based fashion.
+ +
+
|
+ +inline | +
Subscribe to property updates.
+subscriber | |
callback | function |
Subscribe to property changes with a callback to monitor property changes in an event based fashion. Will convert the property to string.
+ +auto PluginServices::TakeDeviceControl | +( | +const std::string & | +controller | ) | +-> void | +
Become device controller.
+controller | id |
fair::mq::PluginServices::DeviceControlError | if there is already a device controller. |
Only one plugin can succeed to take control over device state transitions at a time.
+ +
+
|
+ +inlinestatic | +
Convert string to DeviceState.
+state | to convert |
std::out_of_range | if a string cannot be resolved to a DeviceState |
+
|
+ +inlinestatic | +
Convert string to DeviceStateTransition.
+transition | to convert |
std::out_of_range | if a string cannot be resolved to a DeviceStateTransition |
+
|
+ +inlinestatic | +
Convert DeviceState to string.
+state | to convert |
+
|
+ +inlinestatic | +
Convert DeviceStateTransition to string.
+transition | to convert |
+
|
+ +inline | +
Unsubscribe from device state changes.
+subscriber | id |
+
|
+ +inline | +
Unsubscribe from property updates of type T.
+subscriber |
+
|
+ +inline | +
Unsubscribe from property updates that convert to string.
+subscriber |
+
|
+ +inline | +
Updates multiple existing config properties (or fails of any of then do not exist, leaving property store unchanged)
+props | (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any) |
+
|
+ +inline | +
Updates an existing config property (or fails if it doesn't exist)
+key | |
val |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::ProgOptions, including all inherited members.
+AddChannel(const std::string &name, const FairMQChannel &channel) | fair::mq::ProgOptions | |
AddToCmdLineOptions(const boost::program_options::options_description optDesc, bool visible=true) (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | |
Count(const std::string &key) const | fair::mq::ProgOptions | |
DeleteProperty(const std::string &key) | fair::mq::ProgOptions | |
GetChannelInfo() const | fair::mq::ProgOptions | |
GetCmdLineOptions() (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | |
GetProperties(const std::string &q) const | fair::mq::ProgOptions | |
GetPropertiesAsString(const std::string &q) const | fair::mq::ProgOptions | |
GetPropertiesAsStringStartingWith(const std::string &q) const | fair::mq::ProgOptions | |
GetPropertiesStartingWith(const std::string &q) const | fair::mq::ProgOptions | |
GetProperty(const std::string &key) const | fair::mq::ProgOptions | inline |
GetProperty(const std::string &key, const T &ifNotFound) const | fair::mq::ProgOptions | inline |
GetPropertyAsString(const std::string &key) const | fair::mq::ProgOptions | |
GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const | fair::mq::ProgOptions | |
GetPropertyKeys() const | fair::mq::ProgOptions | |
GetStringValue(const std::string &key) const | fair::mq::ProgOptions | |
GetValue(const std::string &key) const | fair::mq::ProgOptions | inline |
GetVarMap() const | fair::mq::ProgOptions | inline |
Notify() (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | |
ParseAll(const std::vector< std::string > &cmdArgs, bool allowUnregistered) (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | |
ParseAll(const int argc, char const *const *argv, bool allowUnregistered=true) (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | |
PrintHelp() const | fair::mq::ProgOptions | |
PrintOptions() const | fair::mq::ProgOptions | |
PrintOptionsRaw() const | fair::mq::ProgOptions | |
ProgOptions() (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | |
SetProperties(const fair::mq::Properties &input) | fair::mq::ProgOptions | |
SetProperty(const std::string &key, T val) | fair::mq::ProgOptions | inline |
SetValue(const std::string &key, T val) (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | inline |
Subscribe(const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, T)> func) const | fair::mq::ProgOptions | inline |
SubscribeAsString(const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, std::string)> func) const | fair::mq::ProgOptions | inline |
Unsubscribe(const std::string &subscriber) const | fair::mq::ProgOptions | inline |
UnsubscribeAsString(const std::string &subscriber) const | fair::mq::ProgOptions | inline |
UpdateProperties(const fair::mq::Properties &input) | fair::mq::ProgOptions | |
UpdateProperty(const std::string &key, T val) | fair::mq::ProgOptions | inline |
~ProgOptions() (defined in fair::mq::ProgOptions) | fair::mq::ProgOptions | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+void | ParseAll (const std::vector< std::string > &cmdArgs, bool allowUnregistered) |
+void | ParseAll (const int argc, char const *const *argv, bool allowUnregistered=true) |
+void | Notify () |
+void | AddToCmdLineOptions (const boost::program_options::options_description optDesc, bool visible=true) |
+boost::program_options::options_description & | GetCmdLineOptions () |
int | Count (const std::string &key) const |
Checks a property with the given key exist in the configuration. More... | |
std::unordered_map< std::string, int > | GetChannelInfo () const |
Retrieve current channel information. More... | |
std::vector< std::string > | GetPropertyKeys () const |
Discover the list of property keys. More... | |
template<typename T > | |
T | GetProperty (const std::string &key) const |
Read config property, throw if no property with this key exists. More... | |
template<typename T > | |
T | GetProperty (const std::string &key, const T &ifNotFound) const |
Read config property, return provided value if no property with this key exists. More... | |
std::string | GetPropertyAsString (const std::string &key) const |
Read config property as string, throw if no property with this key exists. More... | |
std::string | GetPropertyAsString (const std::string &key, const std::string &ifNotFound) const |
Read config property, return provided value if no property with this key exists. More... | |
fair::mq::Properties | GetProperties (const std::string &q) const |
Read several config properties whose keys match the provided regular expression. More... | |
fair::mq::Properties | GetPropertiesStartingWith (const std::string &q) const |
Read several config properties whose keys start with the provided string. More... | |
std::map< std::string, std::string > | GetPropertiesAsString (const std::string &q) const |
Read several config properties as string whose keys match the provided regular expression. More... | |
std::map< std::string, std::string > | GetPropertiesAsStringStartingWith (const std::string &q) const |
Read several config properties as string whose keys start with the provided string. More... | |
template<typename T > | |
void | SetProperty (const std::string &key, T val) |
Set config property. More... | |
template<typename T > | |
bool | UpdateProperty (const std::string &key, T val) |
Updates an existing config property (or fails if it doesn't exist) More... | |
void | SetProperties (const fair::mq::Properties &input) |
Set multiple config properties. More... | |
bool | UpdateProperties (const fair::mq::Properties &input) |
Updates multiple existing config properties (or fails of any of then do not exist, leaving property store unchanged) More... | |
void | DeleteProperty (const std::string &key) |
Deletes a property with the given key from the config store. More... | |
void | AddChannel (const std::string &name, const FairMQChannel &channel) |
Takes the provided channel and creates properties based on it. More... | |
template<typename T > | |
void | Subscribe (const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, T)> func) const |
Subscribe to property updates of type T. More... | |
template<typename T > | |
void | Unsubscribe (const std::string &subscriber) const |
Unsubscribe from property updates of type T. More... | |
void | SubscribeAsString (const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, std::string)> func) const |
Subscribe to property updates, with values converted to string. More... | |
void | UnsubscribeAsString (const std::string &subscriber) const |
Unsubscribe from property updates that convert to string. More... | |
+void | PrintHelp () const |
prints full options description | |
+void | PrintOptions () const |
prints properties stored in the property container | |
+void | PrintOptionsRaw () const |
prints full options description in a compact machine-readable format | |
+const boost::program_options::variables_map & | GetVarMap () const |
returns the property container | |
template<typename T > | |
T | GetValue (const std::string &key) const |
Read config property, return default-constructed object if key doesn't exist. More... | |
+template<typename T > | |
int | SetValue (const std::string &key, T val) |
std::string | GetStringValue (const std::string &key) const |
Read config property as string, return default-constructed object if key doesn't exist. More... | |
void fair::mq::ProgOptions::AddChannel | +( | +const std::string & | +name, | +
+ | + | const FairMQChannel & | +channel | +
+ | ) | ++ |
Takes the provided channel and creates properties based on it.
+name | channel name |
channel | FairMQChannel reference |
int fair::mq::ProgOptions::Count | +( | +const std::string & | +key | ) | +const | +
Checks a property with the given key exist in the configuration.
+key |
void fair::mq::ProgOptions::DeleteProperty | +( | +const std::string & | +key | ) | ++ |
Deletes a property with the given key from the config store.
+key |
unordered_map< string, int > fair::mq::ProgOptions::GetChannelInfo | +( | +) | +const | +
Retrieve current channel information.
+Properties fair::mq::ProgOptions::GetProperties | +( | +const std::string & | +q | ) | +const | +
Read several config properties whose keys match the provided regular expression.
+q | regex string to match for |
map< string, string > fair::mq::ProgOptions::GetPropertiesAsString | +( | +const std::string & | +q | ) | +const | +
Read several config properties as string whose keys match the provided regular expression.
+q | regex string to match for |
map< string, string > fair::mq::ProgOptions::GetPropertiesAsStringStartingWith | +( | +const std::string & | +q | ) | +const | +
Read several config properties as string whose keys start with the provided string.
+q | string to match for |
Typically more performant than GetPropertiesAsString with regex
+ +Properties fair::mq::ProgOptions::GetPropertiesStartingWith | +( | +const std::string & | +q | ) | +const | +
Read several config properties whose keys start with the provided string.
+q | string to match for |
Typically more performant than GetProperties with regex
+ +
+
|
+ +inline | +
Read config property, throw if no property with this key exists.
+key |
+
|
+ +inline | +
Read config property, return provided value if no property with this key exists.
+key | |
ifNotFound | value to return if key is not found |
std::string fair::mq::ProgOptions::GetPropertyAsString | +( | +const std::string & | +key | ) | +const | +
Read config property as string, throw if no property with this key exists.
+key |
Supports conversion to string for a fixed set of types, for custom/unsupported types add them via fair::mq::PropertyHelper::AddType<MyType>("optional label")
the provided type must then be convertible to string via operator<<
std::string fair::mq::ProgOptions::GetPropertyAsString | +( | +const std::string & | +key, | +
+ | + | const std::string & | +ifNotFound | +
+ | ) | +const | +
Read config property, return provided value if no property with this key exists.
+key | |
ifNotFound | value to return if key is not found |
Supports conversion to string for a fixed set of types, for custom/unsupported types add them via fair::mq::PropertyHelper::AddType<MyType>("optional label")
the provided type must then be convertible to string via operator<<
vector< string > fair::mq::ProgOptions::GetPropertyKeys | +( | +) | +const | +
Discover the list of property keys.
+string fair::mq::ProgOptions::GetStringValue | +( | +const std::string & | +key | ) | +const | +
Read config property as string, return default-constructed object if key doesn't exist.
+key |
+
|
+ +inline | +
Read config property, return default-constructed object if key doesn't exist.
+key |
void fair::mq::ProgOptions::SetProperties | +( | +const fair::mq::Properties & | +input | ) | ++ |
Set multiple config properties.
+props | fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any |
+
|
+ +inline | +
Set config property.
+key | |
val |
+
|
+ +inline | +
Subscribe to property updates of type T.
+subscriber | |
callback | function |
Subscribe to property changes with a callback to monitor property changes in an event based fashion.
+ +
+
|
+ +inline | +
Subscribe to property updates, with values converted to string.
+subscriber | |
callback | function |
Subscribe to property changes with a callback to monitor property changes in an event based fashion. Will convert the property to string.
+ +
+
|
+ +inline | +
Unsubscribe from property updates of type T.
+subscriber |
+
|
+ +inline | +
Unsubscribe from property updates that convert to string.
+subscriber |
bool fair::mq::ProgOptions::UpdateProperties | +( | +const fair::mq::Properties & | +input | ) | ++ |
Updates multiple existing config properties (or fails of any of then do not exist, leaving property store unchanged)
+props | (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any) |
+
|
+ +inline | +
Updates an existing config property (or fails if it doesn't exist)
+key | |
val |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::PropertyHelper, including all inherited members.
+AddType(std::string label="") (defined in fair::mq::PropertyHelper) | fair::mq::PropertyHelper | inlinestatic |
ConvertPropertyToString(const Property &p) (defined in fair::mq::PropertyHelper) | fair::mq::PropertyHelper | inlinestatic |
fEventEmitters (defined in fair::mq::PropertyHelper) | fair::mq::PropertyHelper | static |
GetPropertyInfo(const Property &p) (defined in fair::mq::PropertyHelper) | fair::mq::PropertyHelper | inlinestatic |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Static Public Member Functions | |
+template<typename T > | |
static void | AddType (std::string label="") |
+static std::string | ConvertPropertyToString (const Property &p) |
+static std::pair< std::string, std::string > | GetPropertyInfo (const Property &p) |
+Static Public Attributes | |
+static std::unordered_map< std::type_index, void(*)(const fair::mq::EventManager &, const std::string &, const Property &)> | fEventEmitters |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::StateMachine, including all inherited members.
+ChangeState(const Transition transition) (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
ChangeState(const std::string &transition) (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
GetCurrentState() const (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
GetCurrentStateName() const (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
HandleStates(std::function< void(const State)> callback) (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
NewStatePending() const (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
ProcessWork() (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
Start() (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
StateMachine() (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
StopHandlingStates() (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
SubscribeToNewTransition(const std::string &key, std::function< void(const Transition)> callback) (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
UnsubscribeFromNewTransition(const std::string &key) (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
UnsubscribeFromStateChange(const std::string &key) (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
WaitForPendingState() const (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
WaitForPendingStateFor(const int durationInMs) const (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
~StateMachine() (defined in fair::mq::StateMachine) | fair::mq::StateMachine | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Classes | |
struct | ErrorStateException |
+Public Member Functions | |
+bool | ChangeState (const Transition transition) |
+bool | ChangeState (const std::string &transition) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | HandleStates (std::function< void(const State)> callback) |
+void | StopHandlingStates () |
+void | SubscribeToNewTransition (const std::string &key, std::function< void(const Transition)> callback) |
+void | UnsubscribeFromNewTransition (const std::string &key) |
+bool | NewStatePending () const |
+void | WaitForPendingState () const |
+bool | WaitForPendingStateFor (const int durationInMs) const |
+State | GetCurrentState () const |
+std::string | GetCurrentStateName () const |
+void | Start () |
+void | ProcessWork () |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::StateQueue, including all inherited members.
+Clear() (defined in fair::mq::StateQueue) | fair::mq::StateQueue | inline |
Push(fair::mq::State state) (defined in fair::mq::StateQueue) | fair::mq::StateQueue | inline |
StateQueue() (defined in fair::mq::StateQueue) | fair::mq::StateQueue | inline |
WaitForNext() (defined in fair::mq::StateQueue) | fair::mq::StateQueue | inline |
WaitForNext(std::chrono::duration< Rep, Period > const &duration) (defined in fair::mq::StateQueue) | fair::mq::StateQueue | inline |
WaitForState(fair::mq::State state) (defined in fair::mq::StateQueue) | fair::mq::StateQueue | inline |
~StateQueue() (defined in fair::mq::StateQueue) | fair::mq::StateQueue | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+fair::mq::State | WaitForNext () |
+template<typename Rep , typename Period > | |
std::pair< bool, fair::mq::State > | WaitForNext (std::chrono::duration< Rep, Period > const &duration) |
+void | WaitForState (fair::mq::State state) |
+void | Push (fair::mq::State state) |
+void | Clear () |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::ofi::Context, including all inherited members.
+Context(FairMQTransportFactory &sendFactory, FairMQTransportFactory &receiveFactory, int numberIoThreads=1) (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
ConvertAddress(std::string address) -> Address (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | static |
ConvertAddress(Address address) -> sockaddr_in (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | static |
ConvertAddress(sockaddr_in address) -> Address (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | static |
GetAsiofiVersion() const -> std::string (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
GetIoContext() -> boost::asio::io_context & (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | inline |
GetSizeHint() -> size_t (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | inline |
Interrupt() -> void (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | inline |
MakeReceiveMessage(size_t size) -> MessagePtr (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
MakeSendMessage(size_t size) -> MessagePtr (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
Reset() -> void (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
Resume() -> void (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | inline |
SetSizeHint(size_t size) -> void (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | inline |
VerifyAddress(const std::string &address) -> Address (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | static |
~Context() (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Transport-wide context. + More...
+ +#include <fairmq/ofi/Context.h>
+Public Member Functions | |
+ | Context (FairMQTransportFactory &sendFactory, FairMQTransportFactory &receiveFactory, int numberIoThreads=1) |
+auto | GetAsiofiVersion () const -> std::string |
+auto | GetIoContext () -> boost::asio::io_context & |
+auto | Interrupt () -> void |
+auto | Resume () -> void |
+auto | Reset () -> void |
+auto | MakeReceiveMessage (size_t size) -> MessagePtr |
+auto | MakeSendMessage (size_t size) -> MessagePtr |
+auto | GetSizeHint () -> size_t |
+auto | SetSizeHint (size_t size) -> void |
+Static Public Member Functions | |
+static auto | ConvertAddress (std::string address) -> Address |
+static auto | ConvertAddress (Address address) -> sockaddr_in |
+static auto | ConvertAddress (sockaddr_in address) -> Address |
+static auto | VerifyAddress (const std::string &address) -> Address |
Transport-wide context.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::ofi::Message, including all inherited members.
+Copy(const fair::mq::Message &msg) -> void override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | virtual |
FairMQMessage()=default (defined in FairMQMessage) | FairMQMessage | |
FairMQMessage(FairMQTransportFactory *factory) (defined in FairMQMessage) | FairMQMessage | inline |
GetData() const -> void *override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | virtual |
GetSize() const -> size_t override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | virtual |
GetTransport() (defined in FairMQMessage) | FairMQMessage | inline |
GetType() const -> fair::mq::Transport override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | inlinevirtual |
Message(boost::container::pmr::memory_resource *pmr) (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Message(boost::container::pmr::memory_resource *pmr, const size_t size) (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Message(boost::container::pmr::memory_resource *pmr, void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Message(boost::container::pmr::memory_resource *pmr, FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Message(const Message &)=delete (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
operator=(const Message &)=delete (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Rebuild() -> void override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | virtual |
Rebuild(const size_t size) -> void override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | virtual |
Rebuild(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) -> void override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | virtual |
SetUsedSize(const size_t size) -> bool override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | virtual |
~FairMQMessage() (defined in FairMQMessage) | FairMQMessage | inlinevirtual |
~Message() override (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <fairmq/ofi/Message.h>
+Public Member Functions | |
+ | Message (boost::container::pmr::memory_resource *pmr) |
+ | Message (boost::container::pmr::memory_resource *pmr, const size_t size) |
+ | Message (boost::container::pmr::memory_resource *pmr, void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) |
+ | Message (boost::container::pmr::memory_resource *pmr, FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) |
+ | Message (const Message &)=delete |
+Message | operator= (const Message &)=delete |
+auto | Rebuild () -> void override |
+auto | Rebuild (const size_t size) -> void override |
+auto | Rebuild (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) -> void override |
+auto | GetData () const -> void *override |
+auto | GetSize () const -> size_t override |
+auto | SetUsedSize (const size_t size) -> bool override |
+auto | GetType () const -> fair::mq::Transport override |
+auto | Copy (const fair::mq::Message &msg) -> void override |
![]() | |
+ | FairMQMessage (FairMQTransportFactory *factory) |
+FairMQTransportFactory * | GetTransport () |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::ofi::Poller, including all inherited members.
+CheckInput(const int index) -> bool override (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | virtual |
CheckInput(const std::string &channelKey, const int index) -> bool override (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | virtual |
CheckOutput(const int index) -> bool override (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | virtual |
CheckOutput(const std::string &channelKey, const int index) -> bool override (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | virtual |
FairMQChannel (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | friend |
operator=(const Poller &)=delete (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | |
Poll(const int timeout) -> void override (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | virtual |
Poller(const std::vector< FairMQChannel > &channels) (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | |
Poller(const std::vector< const FairMQChannel *> &channels) (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | |
Poller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | |
Poller(const Poller &)=delete (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | |
SetItemEvents(zmq_pollitem_t &item, const int type) -> void (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | |
TransportFactory (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller | friend |
~FairMQPoller() (defined in FairMQPoller) | FairMQPoller | inlinevirtual |
~Poller() override (defined in fair::mq::ofi::Poller) | fair::mq::ofi::Poller |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <fairmq/ofi/Poller.h>
+Public Member Functions | |
+ | Poller (const std::vector< FairMQChannel > &channels) |
+ | Poller (const std::vector< const FairMQChannel *> &channels) |
+ | Poller (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) |
+ | Poller (const Poller &)=delete |
+Poller | operator= (const Poller &)=delete |
+auto | SetItemEvents (zmq_pollitem_t &item, const int type) -> void |
+auto | Poll (const int timeout) -> void override |
+auto | CheckInput (const int index) -> bool override |
+auto | CheckOutput (const int index) -> bool override |
+auto | CheckInput (const std::string &channelKey, const int index) -> bool override |
+auto | CheckOutput (const std::string &channelKey, const int index) -> bool override |
+Friends | |
+class | FairMQChannel |
+class | TransportFactory |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::ofi::Socket, including all inherited members.
+Bind(const std::string &address) -> bool override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
Close() -> void override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
Connect(const std::string &address) -> bool override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocket(FairMQTransportFactory *fac) (defined in FairMQSocket) | FairMQSocket | inline |
GetBytesRx() const -> unsigned long override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | inlinevirtual |
GetBytesTx() const -> unsigned long override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | inlinevirtual |
GetConstant(const std::string &constant) -> int (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | static |
GetId() const -> std::string override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | inlinevirtual |
GetLinger() const override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
GetMessagesRx() const -> unsigned long override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | inlinevirtual |
GetMessagesTx() const -> unsigned long override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | inlinevirtual |
GetOption(const std::string &option, void *value, size_t *valueSize) -> void override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
GetRcvBufSize() const override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
GetRcvKernelSize() const override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
GetSndBufSize() const override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
GetSndKernelSize() const override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
GetSocket() const -> void * (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | inline |
GetTransport() (defined in FairMQSocket) | FairMQSocket | inline |
operator=(const Socket &)=delete (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
Receive(MessagePtr &msg, int timeout=0) -> int override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
Receive(std::vector< MessagePtr > &msgVec, int timeout=0) -> int64_t override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
Receive(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
Send(MessagePtr &msg, int timeout=0) -> int override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
Send(std::vector< MessagePtr > &msgVec, int timeout=0) -> int64_t override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
Send(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetLinger(const int value) override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
SetOption(const std::string &option, const void *value, size_t valueSize) -> void override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
SetRcvBufSize(const int value) override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
SetRcvKernelSize(const int value) override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
SetSndBufSize(const int value) override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
SetSndKernelSize(const int value) override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | virtual |
SetTransport(FairMQTransportFactory *transport) (defined in FairMQSocket) | FairMQSocket | inline |
Socket(Context &context, const std::string &type, const std::string &name, const std::string &id="") (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
Socket(const Socket &)=delete (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
~FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inlinevirtual |
~Socket() override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <fairmq/ofi/Socket.h>
+Public Member Functions | |
+ | Socket (Context &context, const std::string &type, const std::string &name, const std::string &id="") |
+ | Socket (const Socket &)=delete |
+Socket | operator= (const Socket &)=delete |
+auto | GetId () const -> std::string override |
+auto | Bind (const std::string &address) -> bool override |
+auto | Connect (const std::string &address) -> bool override |
+auto | Send (MessagePtr &msg, int timeout=0) -> int override |
+auto | Receive (MessagePtr &msg, int timeout=0) -> int override |
+auto | Send (std::vector< MessagePtr > &msgVec, int timeout=0) -> int64_t override |
+auto | Receive (std::vector< MessagePtr > &msgVec, int timeout=0) -> int64_t override |
+auto | GetSocket () const -> void * |
+void | SetLinger (const int value) override |
+int | GetLinger () const override |
+void | SetSndBufSize (const int value) override |
+int | GetSndBufSize () const override |
+void | SetRcvBufSize (const int value) override |
+int | GetRcvBufSize () const override |
+void | SetSndKernelSize (const int value) override |
+int | GetSndKernelSize () const override |
+void | SetRcvKernelSize (const int value) override |
+int | GetRcvKernelSize () const override |
+auto | Close () -> void override |
+auto | SetOption (const std::string &option, const void *value, size_t valueSize) -> void override |
+auto | GetOption (const std::string &option, void *value, size_t *valueSize) -> void override |
+auto | GetBytesTx () const -> unsigned long override |
+auto | GetBytesRx () const -> unsigned long override |
+auto | GetMessagesTx () const -> unsigned long override |
+auto | GetMessagesRx () const -> unsigned long override |
![]() | |
+ | FairMQSocket (FairMQTransportFactory *fac) |
+virtual int64_t | Send (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 |
+virtual int64_t | Receive (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 |
+FairMQTransportFactory * | GetTransport () |
+void | SetTransport (FairMQTransportFactory *transport) |
+Static Public Member Functions | |
+static auto | GetConstant (const std::string &constant) -> int |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::ofi::TransportFactory, including all inherited members.
+CreateMessage() -> MessagePtr override | fair::mq::ofi::TransportFactory | virtual |
CreateMessage(const std::size_t size) -> MessagePtr override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
CreateMessage(void *data, const std::size_t size, fairmq_free_fn *ffn, void *hint=nullptr) -> MessagePtr override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
CreateMessage(UnmanagedRegionPtr ®ion, void *data, const std::size_t size, void *hint=nullptr) -> MessagePtr override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
FairMQTransportFactory::CreateMessage(const size_t size)=0 | FairMQTransportFactory | pure virtual |
FairMQTransportFactory::CreateMessage(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr)=0 | FairMQTransportFactory | pure virtual |
FairMQTransportFactory::CreateMessage(FairMQUnmanagedRegionPtr &unmanagedRegion, void *data, const size_t size, void *hint=0)=0 | FairMQTransportFactory | pure virtual |
CreatePoller(const std::vector< FairMQChannel > &channels) const -> PollerPtr override | fair::mq::ofi::TransportFactory | virtual |
CreatePoller(const std::vector< FairMQChannel *> &channels) const -> PollerPtr override | fair::mq::ofi::TransportFactory | virtual |
CreatePoller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const -> PollerPtr override | fair::mq::ofi::TransportFactory | virtual |
CreateSocket(const std::string &type, const std::string &name) -> SocketPtr override | fair::mq::ofi::TransportFactory | virtual |
CreateTransportFactory(const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const -> UnmanagedRegionPtr override | fair::mq::ofi::TransportFactory | virtual |
CreateUnmanagedRegion(const size_t size, int64_t userFlags, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const -> UnmanagedRegionPtr override | fair::mq::ofi::TransportFactory | virtual |
FairMQNoCleanup(void *, void *) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQSimpleMsgCleanup(void *, void *obj) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQTransportFactory(const std::string &id) | FairMQTransportFactory | |
GetId() const -> const std::string (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
GetMemoryResource() | FairMQTransportFactory | inline |
GetRegionInfo() override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | inlinevirtual |
GetType() const -> Transport override | fair::mq::ofi::TransportFactory | virtual |
Interrupt() override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | inlinevirtual |
NewSimpleMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const char(&data)[N]) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator fair::mq::ChannelResource *() (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator=(const TransportFactory &)=delete (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
Reset() override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | inlinevirtual |
Resume() override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | inlinevirtual |
SubscribeToRegionEvents(RegionEventCallback) override | fair::mq::ofi::TransportFactory | inlinevirtual |
TransportFactory(const std::string &id="", const fair::mq::ProgOptions *config=nullptr) (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
TransportFactory(const TransportFactory &)=delete (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
UnsubscribeFromRegionEvents() override | fair::mq::ofi::TransportFactory | inlinevirtual |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
FairMQ transport factory for the ofi transport. + More...
+ +#include <fairmq/ofi/TransportFactory.h>
+Public Member Functions | |
+ | TransportFactory (const std::string &id="", const fair::mq::ProgOptions *config=nullptr) |
+ | TransportFactory (const TransportFactory &)=delete |
+TransportFactory | operator= (const TransportFactory &)=delete |
auto | CreateMessage () -> MessagePtr override |
Create empty FairMQMessage. More... | |
+auto | CreateMessage (const std::size_t size) -> MessagePtr override |
+auto | CreateMessage (void *data, const std::size_t size, fairmq_free_fn *ffn, void *hint=nullptr) -> MessagePtr override |
+auto | CreateMessage (UnmanagedRegionPtr ®ion, void *data, const std::size_t size, void *hint=nullptr) -> MessagePtr override |
+auto | CreateSocket (const std::string &type, const std::string &name) -> SocketPtr override |
Create a socket. | |
+auto | CreatePoller (const std::vector< FairMQChannel > &channels) const -> PollerPtr override |
Create a poller for a single channel (all subchannels) | |
+auto | CreatePoller (const std::vector< FairMQChannel *> &channels) const -> PollerPtr override |
Create a poller for specific channels. | |
+auto | CreatePoller (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const -> PollerPtr override |
Create a poller for specific channels (all subchannels) | |
auto | CreateUnmanagedRegion (const size_t size, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const -> UnmanagedRegionPtr override |
Create new UnmanagedRegion. More... | |
auto | CreateUnmanagedRegion (const size_t size, int64_t userFlags, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const -> UnmanagedRegionPtr override |
Create new UnmanagedRegion. More... | |
void | SubscribeToRegionEvents (RegionEventCallback) override |
Subscribe to region events (creation, destruction, ...) More... | |
+void | UnsubscribeFromRegionEvents () override |
Unsubscribe from region events. | |
+std::vector< FairMQRegionInfo > | GetRegionInfo () override |
+auto | GetType () const -> Transport override |
Get transport type. | |
+void | Interrupt () override |
+void | Resume () override |
+void | Reset () override |
![]() | |
FairMQTransportFactory (const std::string &id) | |
+auto | GetId () const -> const std::string |
+fair::mq::ChannelResource * | GetMemoryResource () |
Get a pointer to the associated polymorphic memory resource. | |
+ | operator fair::mq::ChannelResource * () |
virtual FairMQMessagePtr | CreateMessage (const size_t size)=0 |
Create new FairMQMessage of specified size. More... | |
virtual FairMQMessagePtr | CreateMessage (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr)=0 |
Create new FairMQMessage with user provided buffer and size. More... | |
virtual FairMQMessagePtr | CreateMessage (FairMQUnmanagedRegionPtr &unmanagedRegion, void *data, const size_t size, void *hint=0)=0 |
create a message with the buffer located within the corresponding unmanaged region More... | |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<std::size_t N> | |
FairMQMessagePtr | NewSimpleMessage (const char(&data)[N]) |
+FairMQMessagePtr | NewSimpleMessage (const std::string &str) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+FairMQMessagePtr | NewStaticMessage (const std::string &str) |
+Additional Inherited Members | |
![]() | |
+static auto | CreateTransportFactory (const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > |
+static void | FairMQNoCleanup (void *, void *) |
+template<typename T > | |
static void | FairMQSimpleMsgCleanup (void *, void *obj) |
FairMQ transport factory for the ofi transport.
+
+
|
+ +overridevirtual | +
Create empty FairMQMessage.
+Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
userFlags | flags to be stored with the region, have no effect on the transport, but can be retrieved from the region by the user |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +inlineoverridevirtual | +
Subscribe to region events (creation, destruction, ...)
+callback | the callback that is called when a region event occurs |
Implements FairMQTransportFactory.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::plugins::Config, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> bool (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
Config(const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) (defined in fair::mq::plugins::Config) | fair::mq::plugins::Config | |
CycleLogConsoleSeverityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeleteProperty(const std::string &key) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeviceState typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
DeviceStateTransition typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
GetChannelInfo() const -> std::unordered_map< std::string, int > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetCurrentDeviceState() const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetHomepage() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetMaintainer() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetName() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperties(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsString(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsStringStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key, const T &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyKeys() const -> std::vector< std::string > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetVersion() const -> const Version (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
NoProgramOptions() -> ProgOptions (defined in fair::mq::Plugin) | fair::mq::Plugin | inlinestatic |
operator=(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin()=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
ProgOptions typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
PropertyExists(const std::string &key) -> int (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ReleaseDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperties(const fair::mq::Properties &props) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperty(const std::string &key, T val) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
StealDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToDeviceStateChange(std::function< void(DeviceState)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChange(std::function< void(const std::string &key, T newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChangeAsString(std::function< void(const std::string &key, std::string newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
TakeDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceState(const std::string &state) const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceStateTransition(const std::string &transition) const -> DeviceStateTransition (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceState state) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceStateTransition transition) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromDeviceStateChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChangeAsString() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperties(const fair::mq::Properties &input) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperty(const std::string &key, T val) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
Version typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
~Config() (defined in fair::mq::plugins::Config) | fair::mq::plugins::Config | |
~Plugin() (defined in fair::mq::Plugin) | fair::mq::Plugin | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | Config (const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) |
![]() | |
+ | Plugin (std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) |
+ | Plugin (const Plugin &)=delete |
+Plugin | operator= (const Plugin &)=delete |
+auto | GetName () const -> const std::string & |
+auto | GetVersion () const -> const Version |
+auto | GetMaintainer () const -> const std::string & |
+auto | GetHomepage () const -> const std::string & |
+auto | ToDeviceState (const std::string &state) const -> DeviceState |
+auto | ToDeviceStateTransition (const std::string &transition) const -> DeviceStateTransition |
+auto | ToStr (DeviceState state) const -> std::string |
+auto | ToStr (DeviceStateTransition transition) const -> std::string |
+auto | GetCurrentDeviceState () const -> DeviceState |
+auto | TakeDeviceControl () -> void |
+auto | StealDeviceControl () -> void |
+auto | ReleaseDeviceControl () -> void |
+auto | ChangeDeviceState (const DeviceStateTransition next) -> bool |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
T | GetProperty (const std::string &key) const |
+template<typename T > | |
T | GetProperty (const std::string &key, const T &ifNotFound) const |
+std::string | GetPropertyAsString (const std::string &key) const |
+std::string | GetPropertyAsString (const std::string &key, const std::string &ifNotFound) const |
+fair::mq::Properties | GetProperties (const std::string &q) const |
+fair::mq::Properties | GetPropertiesStartingWith (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsString (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsStringStartingWith (const std::string &q) const |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+void | SetProperties (const fair::mq::Properties &props) |
+template<typename T > | |
bool | UpdateProperty (const std::string &key, T val) |
+bool | UpdateProperties (const fair::mq::Properties &input) |
+void | DeleteProperty (const std::string &key) |
+template<typename T > | |
auto | SubscribeToPropertyChange (std::function< void(const std::string &key, T newValue)> callback) -> void |
+template<typename T > | |
auto | UnsubscribeFromPropertyChange () -> void |
+auto | SubscribeToPropertyChangeAsString (std::function< void(const std::string &key, std::string newValue)> callback) -> void |
+auto | UnsubscribeFromPropertyChangeAsString () -> void |
+auto | CycleLogConsoleSeverityUp () -> void |
+auto | CycleLogConsoleSeverityDown () -> void |
+auto | CycleLogVerbosityUp () -> void |
+auto | CycleLogVerbosityDown () -> void |
+Additional Inherited Members | |
![]() | |
+using | ProgOptions = boost::optional< boost::program_options::options_description > |
+using | Version = tools::Version |
+using | DeviceState = fair::mq::PluginServices::DeviceState |
+using | DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransition |
![]() | |
+static auto | NoProgramOptions () -> ProgOptions |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::plugins::Control, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> bool (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
Control(const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) (defined in fair::mq::plugins::Control) | fair::mq::plugins::Control | |
CycleLogConsoleSeverityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeleteProperty(const std::string &key) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeviceState typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
DeviceStateTransition typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
GetChannelInfo() const -> std::unordered_map< std::string, int > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetCurrentDeviceState() const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetHomepage() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetMaintainer() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetName() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperties(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsString(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsStringStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key, const T &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyKeys() const -> std::vector< std::string > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetVersion() const -> const Version (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
NoProgramOptions() -> ProgOptions (defined in fair::mq::Plugin) | fair::mq::Plugin | inlinestatic |
operator=(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin()=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
ProgOptions typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
PropertyExists(const std::string &key) -> int (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ReleaseDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperties(const fair::mq::Properties &props) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperty(const std::string &key, T val) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
StealDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToDeviceStateChange(std::function< void(DeviceState)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChange(std::function< void(const std::string &key, T newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChangeAsString(std::function< void(const std::string &key, std::string newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
TakeDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceState(const std::string &state) const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceStateTransition(const std::string &transition) const -> DeviceStateTransition (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceState state) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceStateTransition transition) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromDeviceStateChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChangeAsString() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperties(const fair::mq::Properties &input) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperty(const std::string &key, T val) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
Version typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
~Control() (defined in fair::mq::plugins::Control) | fair::mq::plugins::Control | |
~Plugin() (defined in fair::mq::Plugin) | fair::mq::Plugin | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | Control (const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) |
![]() | |
+ | Plugin (std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) |
+ | Plugin (const Plugin &)=delete |
+Plugin | operator= (const Plugin &)=delete |
+auto | GetName () const -> const std::string & |
+auto | GetVersion () const -> const Version |
+auto | GetMaintainer () const -> const std::string & |
+auto | GetHomepage () const -> const std::string & |
+auto | ToDeviceState (const std::string &state) const -> DeviceState |
+auto | ToDeviceStateTransition (const std::string &transition) const -> DeviceStateTransition |
+auto | ToStr (DeviceState state) const -> std::string |
+auto | ToStr (DeviceStateTransition transition) const -> std::string |
+auto | GetCurrentDeviceState () const -> DeviceState |
+auto | TakeDeviceControl () -> void |
+auto | StealDeviceControl () -> void |
+auto | ReleaseDeviceControl () -> void |
+auto | ChangeDeviceState (const DeviceStateTransition next) -> bool |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
T | GetProperty (const std::string &key) const |
+template<typename T > | |
T | GetProperty (const std::string &key, const T &ifNotFound) const |
+std::string | GetPropertyAsString (const std::string &key) const |
+std::string | GetPropertyAsString (const std::string &key, const std::string &ifNotFound) const |
+fair::mq::Properties | GetProperties (const std::string &q) const |
+fair::mq::Properties | GetPropertiesStartingWith (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsString (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsStringStartingWith (const std::string &q) const |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+void | SetProperties (const fair::mq::Properties &props) |
+template<typename T > | |
bool | UpdateProperty (const std::string &key, T val) |
+bool | UpdateProperties (const fair::mq::Properties &input) |
+void | DeleteProperty (const std::string &key) |
+template<typename T > | |
auto | SubscribeToPropertyChange (std::function< void(const std::string &key, T newValue)> callback) -> void |
+template<typename T > | |
auto | UnsubscribeFromPropertyChange () -> void |
+auto | SubscribeToPropertyChangeAsString (std::function< void(const std::string &key, std::string newValue)> callback) -> void |
+auto | UnsubscribeFromPropertyChangeAsString () -> void |
+auto | CycleLogConsoleSeverityUp () -> void |
+auto | CycleLogConsoleSeverityDown () -> void |
+auto | CycleLogVerbosityUp () -> void |
+auto | CycleLogVerbosityDown () -> void |
+Additional Inherited Members | |
![]() | |
+using | ProgOptions = boost::optional< boost::program_options::options_description > |
+using | Version = tools::Version |
+using | DeviceState = fair::mq::PluginServices::DeviceState |
+using | DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransition |
![]() | |
+static auto | NoProgramOptions () -> ProgOptions |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::plugins::DDS, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> bool (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DDS(const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) (defined in fair::mq::plugins::DDS) | fair::mq::plugins::DDS | |
DeleteProperty(const std::string &key) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeviceState typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
DeviceStateTransition typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
GetChannelInfo() const -> std::unordered_map< std::string, int > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetCurrentDeviceState() const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetHomepage() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetMaintainer() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetName() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperties(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsString(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsStringStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key, const T &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyKeys() const -> std::vector< std::string > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetVersion() const -> const Version (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
NoProgramOptions() -> ProgOptions (defined in fair::mq::Plugin) | fair::mq::Plugin | inlinestatic |
operator=(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin()=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
ProgOptions typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
PropertyExists(const std::string &key) -> int (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ReleaseDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperties(const fair::mq::Properties &props) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperty(const std::string &key, T val) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
StealDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToDeviceStateChange(std::function< void(DeviceState)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChange(std::function< void(const std::string &key, T newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChangeAsString(std::function< void(const std::string &key, std::string newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
TakeDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceState(const std::string &state) const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceStateTransition(const std::string &transition) const -> DeviceStateTransition (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceState state) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceStateTransition transition) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromDeviceStateChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChangeAsString() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperties(const fair::mq::Properties &input) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperty(const std::string &key, T val) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
Version typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
~DDS() (defined in fair::mq::plugins::DDS) | fair::mq::plugins::DDS | |
~Plugin() (defined in fair::mq::Plugin) | fair::mq::Plugin | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | DDS (const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) |
![]() | |
+ | Plugin (std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) |
+ | Plugin (const Plugin &)=delete |
+Plugin | operator= (const Plugin &)=delete |
+auto | GetName () const -> const std::string & |
+auto | GetVersion () const -> const Version |
+auto | GetMaintainer () const -> const std::string & |
+auto | GetHomepage () const -> const std::string & |
+auto | ToDeviceState (const std::string &state) const -> DeviceState |
+auto | ToDeviceStateTransition (const std::string &transition) const -> DeviceStateTransition |
+auto | ToStr (DeviceState state) const -> std::string |
+auto | ToStr (DeviceStateTransition transition) const -> std::string |
+auto | GetCurrentDeviceState () const -> DeviceState |
+auto | TakeDeviceControl () -> void |
+auto | StealDeviceControl () -> void |
+auto | ReleaseDeviceControl () -> void |
+auto | ChangeDeviceState (const DeviceStateTransition next) -> bool |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
T | GetProperty (const std::string &key) const |
+template<typename T > | |
T | GetProperty (const std::string &key, const T &ifNotFound) const |
+std::string | GetPropertyAsString (const std::string &key) const |
+std::string | GetPropertyAsString (const std::string &key, const std::string &ifNotFound) const |
+fair::mq::Properties | GetProperties (const std::string &q) const |
+fair::mq::Properties | GetPropertiesStartingWith (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsString (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsStringStartingWith (const std::string &q) const |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+void | SetProperties (const fair::mq::Properties &props) |
+template<typename T > | |
bool | UpdateProperty (const std::string &key, T val) |
+bool | UpdateProperties (const fair::mq::Properties &input) |
+void | DeleteProperty (const std::string &key) |
+template<typename T > | |
auto | SubscribeToPropertyChange (std::function< void(const std::string &key, T newValue)> callback) -> void |
+template<typename T > | |
auto | UnsubscribeFromPropertyChange () -> void |
+auto | SubscribeToPropertyChangeAsString (std::function< void(const std::string &key, std::string newValue)> callback) -> void |
+auto | UnsubscribeFromPropertyChangeAsString () -> void |
+auto | CycleLogConsoleSeverityUp () -> void |
+auto | CycleLogConsoleSeverityDown () -> void |
+auto | CycleLogVerbosityUp () -> void |
+auto | CycleLogVerbosityDown () -> void |
+Additional Inherited Members | |
![]() | |
+using | ProgOptions = boost::optional< boost::program_options::options_description > |
+using | Version = tools::Version |
+using | DeviceState = fair::mq::PluginServices::DeviceState |
+using | DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransition |
![]() | |
+static auto | NoProgramOptions () -> ProgOptions |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::plugins::PMIxPlugin, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> bool (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogConsoleSeverityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityDown() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
CycleLogVerbosityUp() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeleteProperty(const std::string &key) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
DeviceState typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
DeviceStateTransition typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
GetChannelInfo() const -> std::unordered_map< std::string, int > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetCurrentDeviceState() const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetHomepage() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetMaintainer() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetName() const -> const std::string & (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperties(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsString(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesAsStringStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertiesStartingWith(const std::string &q) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetProperty(const std::string &key, const T &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyKeys() const -> std::vector< std::string > (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetVersion() const -> const Version (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
NoProgramOptions() -> ProgOptions (defined in fair::mq::Plugin) | fair::mq::Plugin | inlinestatic |
operator=(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin()=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) (defined in fair::mq::Plugin) | fair::mq::Plugin | |
Plugin(const Plugin &)=delete (defined in fair::mq::Plugin) | fair::mq::Plugin | |
PMIxClient() const -> std::string (defined in fair::mq::plugins::PMIxPlugin) | fair::mq::plugins::PMIxPlugin | inline |
PMIxPlugin(const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) (defined in fair::mq::plugins::PMIxPlugin) | fair::mq::plugins::PMIxPlugin | |
ProgOptions typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
PropertyExists(const std::string &key) -> int (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ReleaseDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperties(const fair::mq::Properties &props) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SetProperty(const std::string &key, T val) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
StealDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToDeviceStateChange(std::function< void(DeviceState)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChange(std::function< void(const std::string &key, T newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
SubscribeToPropertyChangeAsString(std::function< void(const std::string &key, std::string newValue)> callback) -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
TakeDeviceControl() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceState(const std::string &state) const -> DeviceState (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToDeviceStateTransition(const std::string &transition) const -> DeviceStateTransition (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceState state) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
ToStr(DeviceStateTransition transition) const -> std::string (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromDeviceStateChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChange() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UnsubscribeFromPropertyChangeAsString() -> void (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperties(const fair::mq::Properties &input) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
UpdateProperty(const std::string &key, T val) (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
Version typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
~Plugin() (defined in fair::mq::Plugin) | fair::mq::Plugin | virtual |
~PMIxPlugin() (defined in fair::mq::plugins::PMIxPlugin) | fair::mq::plugins::PMIxPlugin |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | PMIxPlugin (const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) |
+auto | PMIxClient () const -> std::string |
![]() | |
+ | Plugin (std::string name, Version version, std::string maintainer, std::string homepage, PluginServices *pluginServices) |
+ | Plugin (const Plugin &)=delete |
+Plugin | operator= (const Plugin &)=delete |
+auto | GetName () const -> const std::string & |
+auto | GetVersion () const -> const Version |
+auto | GetMaintainer () const -> const std::string & |
+auto | GetHomepage () const -> const std::string & |
+auto | ToDeviceState (const std::string &state) const -> DeviceState |
+auto | ToDeviceStateTransition (const std::string &transition) const -> DeviceStateTransition |
+auto | ToStr (DeviceState state) const -> std::string |
+auto | ToStr (DeviceStateTransition transition) const -> std::string |
+auto | GetCurrentDeviceState () const -> DeviceState |
+auto | TakeDeviceControl () -> void |
+auto | StealDeviceControl () -> void |
+auto | ReleaseDeviceControl () -> void |
+auto | ChangeDeviceState (const DeviceStateTransition next) -> bool |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
T | GetProperty (const std::string &key) const |
+template<typename T > | |
T | GetProperty (const std::string &key, const T &ifNotFound) const |
+std::string | GetPropertyAsString (const std::string &key) const |
+std::string | GetPropertyAsString (const std::string &key, const std::string &ifNotFound) const |
+fair::mq::Properties | GetProperties (const std::string &q) const |
+fair::mq::Properties | GetPropertiesStartingWith (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsString (const std::string &q) const |
+std::map< std::string, std::string > | GetPropertiesAsStringStartingWith (const std::string &q) const |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+void | SetProperties (const fair::mq::Properties &props) |
+template<typename T > | |
bool | UpdateProperty (const std::string &key, T val) |
+bool | UpdateProperties (const fair::mq::Properties &input) |
+void | DeleteProperty (const std::string &key) |
+template<typename T > | |
auto | SubscribeToPropertyChange (std::function< void(const std::string &key, T newValue)> callback) -> void |
+template<typename T > | |
auto | UnsubscribeFromPropertyChange () -> void |
+auto | SubscribeToPropertyChangeAsString (std::function< void(const std::string &key, std::string newValue)> callback) -> void |
+auto | UnsubscribeFromPropertyChangeAsString () -> void |
+auto | CycleLogConsoleSeverityUp () -> void |
+auto | CycleLogConsoleSeverityDown () -> void |
+auto | CycleLogVerbosityUp () -> void |
+auto | CycleLogVerbosityDown () -> void |
+Additional Inherited Members | |
![]() | |
+using | ProgOptions = boost::optional< boost::program_options::options_description > |
+using | Version = tools::Version |
+using | DeviceState = fair::mq::PluginServices::DeviceState |
+using | DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransition |
![]() | |
+static auto | NoProgramOptions () -> ProgOptions |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::AsioBase< Executor, Allocator >, including all inherited members.
+AllocatorType typedef | fair::mq::sdk::AsioBase< Executor, Allocator > | |
AsioBase()=delete | fair::mq::sdk::AsioBase< Executor, Allocator > | |
AsioBase(Executor ex, Allocator alloc) | fair::mq::sdk::AsioBase< Executor, Allocator > | inlineexplicit |
AsioBase(const AsioBase &)=delete | fair::mq::sdk::AsioBase< Executor, Allocator > | |
AsioBase(AsioBase &&) noexcept=default | fair::mq::sdk::AsioBase< Executor, Allocator > | |
ExecutorType typedef | fair::mq::sdk::AsioBase< Executor, Allocator > | |
GetAllocator() const noexcept -> AllocatorType | fair::mq::sdk::AsioBase< Executor, Allocator > | inline |
GetExecutor() const noexcept -> ExecutorType | fair::mq::sdk::AsioBase< Executor, Allocator > | inline |
operator=(const AsioBase &)=delete (defined in fair::mq::sdk::AsioBase< Executor, Allocator >) | fair::mq::sdk::AsioBase< Executor, Allocator > | |
operator=(AsioBase &&) noexcept=default (defined in fair::mq::sdk::AsioBase< Executor, Allocator >) | fair::mq::sdk::AsioBase< Executor, Allocator > | |
~AsioBase()=default (defined in fair::mq::sdk::AsioBase< Executor, Allocator >) | fair::mq::sdk::AsioBase< Executor, Allocator > |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Base for creating Asio-enabled I/O objects. + More...
+ +#include <fairmq/sdk/AsioBase.h>
+Public Types | |
+using | ExecutorType = Executor |
Member type of associated I/O executor. | |
+using | AllocatorType = Allocator |
Member type of associated default allocator. | |
+Public Member Functions | |
+auto | GetExecutor () const noexcept -> ExecutorType |
Get associated I/O executor. | |
+auto | GetAllocator () const noexcept -> AllocatorType |
Get associated default allocator. | |
+ | AsioBase ()=delete |
NO default ctor. | |
+ | AsioBase (Executor ex, Allocator alloc) |
Construct with associated I/O executor. | |
+ | AsioBase (const AsioBase &)=delete |
NOT copyable. | |
+AsioBase & | operator= (const AsioBase &)=delete |
+ | AsioBase (AsioBase &&) noexcept=default |
movable | |
+AsioBase & | operator= (AsioBase &&) noexcept=default |
Base for creating Asio-enabled I/O objects.
+Executor | Associated I/O executor |
Allocator | Associated default allocator |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::BasicTopology< Executor, Allocator >, including all inherited members.
+AggregateState() const -> DeviceState (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AllocatorType typedef | fair::mq::sdk::AsioBase< Executor, Allocator > | |
AsioBase()=delete | fair::mq::sdk::AsioBase< Executor, Allocator > | |
AsioBase(Executor ex, Allocator alloc) | fair::mq::sdk::AsioBase< Executor, Allocator > | inlineexplicit |
AsioBase(const AsioBase &)=delete | fair::mq::sdk::AsioBase< Executor, Allocator > | |
AsioBase(AsioBase &&) noexcept=default | fair::mq::sdk::AsioBase< Executor, Allocator > | |
AsyncChangeState(const TopologyTransition transition, const std::string &path, Duration timeout, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncChangeState(const TopologyTransition transition, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncChangeState(const TopologyTransition transition, Duration timeout, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncChangeState(const TopologyTransition transition, const std::string &path, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncGetProperties(DevicePropertyQuery const &query, const std::string &path, Duration timeout, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncGetProperties(DevicePropertyQuery const &query, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncSetProperties(const DeviceProperties &props, const std::string &path, Duration timeout, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncSetProperties(DeviceProperties const &props, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncWaitForState(const DeviceState targetLastState, const DeviceState targetCurrentState, const std::string &path, Duration timeout, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncWaitForState(const DeviceState targetLastState, const DeviceState targetCurrentState, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
AsyncWaitForState(const DeviceState targetCurrentState, CompletionToken &&token) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
BasicTopology(DDSTopology topo, DDSSession session) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
BasicTopology(const Executor &ex, DDSTopology topo, DDSSession session, Allocator alloc=DefaultAllocator()) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
BasicTopology(const BasicTopology &)=delete | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
BasicTopology(BasicTopology &&)=default | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
ChangeState(const TopologyTransition transition, const std::string &path="", Duration timeout=Duration(0)) -> std::pair< std::error_code, TopologyState > | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
ChangeState(const TopologyTransition transition, Duration timeout) -> std::pair< std::error_code, TopologyState > | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
ChangeStateCompletionSignature typedef (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
Duration typedef (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
ExecutorType typedef | fair::mq::sdk::AsioBase< Executor, Allocator > | |
GetAllocator() const noexcept -> AllocatorType | fair::mq::sdk::AsioBase< Executor, Allocator > | inline |
GetCurrentState() const -> TopologyState | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
GetExecutor() const noexcept -> ExecutorType | fair::mq::sdk::AsioBase< Executor, Allocator > | inline |
GetHeartbeatInterval() const (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
GetProperties(DevicePropertyQuery const &query, const std::string &path="", Duration timeout=Duration(0)) -> std::pair< std::error_code, GetPropertiesResult > | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
GetPropertiesCompletionSignature typedef (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
HandleCmd(cmd::StateChangeSubscription const &cmd) -> void (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
HandleCmd(cmd::StateChangeUnsubscription const &cmd) -> void (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
HandleCmd(cmd::StateChange const &cmd, DDSChannel::Id const &senderId) -> void (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
HandleCmd(cmd::TransitionStatus const &cmd) -> void (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
HandleCmd(cmd::Properties const &cmd) -> void (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
HandleCmd(cmd::PropertiesSet const &cmd) -> void (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
operator=(const BasicTopology &)=delete (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
operator=(BasicTopology &&)=default (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
operator=(const AsioBase &)=delete (defined in fair::mq::sdk::AsioBase< Executor, Allocator >) | fair::mq::sdk::AsioBase< Executor, Allocator > | |
operator=(AsioBase &&) noexcept=default (defined in fair::mq::sdk::AsioBase< Executor, Allocator >) | fair::mq::sdk::AsioBase< Executor, Allocator > | |
SendSubscriptionHeartbeats(const std::error_code &ec) (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
SetHeartbeatInterval(Duration duration) (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
SetProperties(DeviceProperties const &properties, const std::string &path="", Duration timeout=Duration(0)) -> std::pair< std::error_code, FailedDevices > | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
SetPropertiesCompletionSignature typedef (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
StateEqualsTo(DeviceState state) const -> bool (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
SubscribeToCommands() (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
SubscribeToStateChanges() (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
UnsubscribeFromStateChanges() (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
WaitForState(const DeviceState targetLastState, const DeviceState targetCurrentState, const std::string &path="", Duration timeout=Duration(0)) -> std::error_code | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
WaitForState(const DeviceState targetCurrentState, const std::string &path="", Duration timeout=Duration(0)) -> std::error_code | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
WaitForStateCompletionSignature typedef (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | |
~AsioBase()=default (defined in fair::mq::sdk::AsioBase< Executor, Allocator >) | fair::mq::sdk::AsioBase< Executor, Allocator > | |
~BasicTopology() (defined in fair::mq::sdk::BasicTopology< Executor, Allocator >) | fair::mq::sdk::BasicTopology< Executor, Allocator > | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Represents a FairMQ topology. + More...
+ +#include <fairmq/sdk/Topology.h>
+Public Types | |
+using | Duration = std::chrono::milliseconds |
+using | ChangeStateCompletionSignature = void(std::error_code, TopologyState) |
+using | WaitForStateCompletionSignature = void(std::error_code) |
+using | GetPropertiesCompletionSignature = void(std::error_code, GetPropertiesResult) |
+using | SetPropertiesCompletionSignature = void(std::error_code, FailedDevices) |
![]() | |
+using | ExecutorType = Executor |
Member type of associated I/O executor. | |
+using | AllocatorType = Allocator |
Member type of associated default allocator. | |
+Public Member Functions | |
BasicTopology (DDSTopology topo, DDSSession session) | |
(Re)Construct a FairMQ topology from an existing DDS topology More... | |
BasicTopology (const Executor &ex, DDSTopology topo, DDSSession session, Allocator alloc=DefaultAllocator()) | |
(Re)Construct a FairMQ topology from an existing DDS topology More... | |
+ | BasicTopology (const BasicTopology &)=delete |
not copyable | |
+BasicTopology & | operator= (const BasicTopology &)=delete |
+ | BasicTopology (BasicTopology &&)=default |
movable | |
+BasicTopology & | operator= (BasicTopology &&)=default |
+void | SubscribeToStateChanges () |
+void | SendSubscriptionHeartbeats (const std::error_code &ec) |
+void | UnsubscribeFromStateChanges () |
+void | SubscribeToCommands () |
+auto | HandleCmd (cmd::StateChangeSubscription const &cmd) -> void |
+auto | HandleCmd (cmd::StateChangeUnsubscription const &cmd) -> void |
+auto | HandleCmd (cmd::StateChange const &cmd, DDSChannel::Id const &senderId) -> void |
+auto | HandleCmd (cmd::TransitionStatus const &cmd) -> void |
+auto | HandleCmd (cmd::Properties const &cmd) -> void |
+auto | HandleCmd (cmd::PropertiesSet const &cmd) -> void |
template<typename CompletionToken > | |
auto | AsyncChangeState (const TopologyTransition transition, const std::string &path, Duration timeout, CompletionToken &&token) |
Initiate state transition on all FairMQ devices in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncChangeState (const TopologyTransition transition, CompletionToken &&token) |
Initiate state transition on all FairMQ devices in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncChangeState (const TopologyTransition transition, Duration timeout, CompletionToken &&token) |
Initiate state transition on all FairMQ devices in this topology with a timeout. More... | |
template<typename CompletionToken > | |
auto | AsyncChangeState (const TopologyTransition transition, const std::string &path, CompletionToken &&token) |
Initiate state transition on all FairMQ devices in this topology with a timeout. More... | |
auto | ChangeState (const TopologyTransition transition, const std::string &path="", Duration timeout=Duration(0)) -> std::pair< std::error_code, TopologyState > |
Perform state transition on FairMQ devices in this topology for a specified topology path. More... | |
auto | ChangeState (const TopologyTransition transition, Duration timeout) -> std::pair< std::error_code, TopologyState > |
Perform state transition on all FairMQ devices in this topology with a timeout. More... | |
auto | GetCurrentState () const -> TopologyState |
Returns the current state of the topology. More... | |
+auto | AggregateState () const -> DeviceState |
+auto | StateEqualsTo (DeviceState state) const -> bool |
template<typename CompletionToken > | |
auto | AsyncWaitForState (const DeviceState targetLastState, const DeviceState targetCurrentState, const std::string &path, Duration timeout, CompletionToken &&token) |
Initiate waiting for selected FairMQ devices to reach given last & current state in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncWaitForState (const DeviceState targetLastState, const DeviceState targetCurrentState, CompletionToken &&token) |
Initiate waiting for selected FairMQ devices to reach given last & current state in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncWaitForState (const DeviceState targetCurrentState, CompletionToken &&token) |
Initiate waiting for selected FairMQ devices to reach given current state in this topology. More... | |
auto | WaitForState (const DeviceState targetLastState, const DeviceState targetCurrentState, const std::string &path="", Duration timeout=Duration(0)) -> std::error_code |
Wait for selected FairMQ devices to reach given last & current state in this topology. More... | |
auto | WaitForState (const DeviceState targetCurrentState, const std::string &path="", Duration timeout=Duration(0)) -> std::error_code |
Wait for selected FairMQ devices to reach given current state in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncGetProperties (DevicePropertyQuery const &query, const std::string &path, Duration timeout, CompletionToken &&token) |
Initiate property query on selected FairMQ devices in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncGetProperties (DevicePropertyQuery const &query, CompletionToken &&token) |
Initiate property query on selected FairMQ devices in this topology. More... | |
auto | GetProperties (DevicePropertyQuery const &query, const std::string &path="", Duration timeout=Duration(0)) -> std::pair< std::error_code, GetPropertiesResult > |
Query properties on selected FairMQ devices in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncSetProperties (const DeviceProperties &props, const std::string &path, Duration timeout, CompletionToken &&token) |
Initiate property update on selected FairMQ devices in this topology. More... | |
template<typename CompletionToken > | |
auto | AsyncSetProperties (DeviceProperties const &props, CompletionToken &&token) |
Initiate property update on selected FairMQ devices in this topology. More... | |
auto | SetProperties (DeviceProperties const &properties, const std::string &path="", Duration timeout=Duration(0)) -> std::pair< std::error_code, FailedDevices > |
Set properties on selected FairMQ devices in this topology. More... | |
+Duration | GetHeartbeatInterval () const |
+void | SetHeartbeatInterval (Duration duration) |
![]() | |
+auto | GetExecutor () const noexcept -> ExecutorType |
Get associated I/O executor. | |
+auto | GetAllocator () const noexcept -> AllocatorType |
Get associated default allocator. | |
+ | AsioBase ()=delete |
NO default ctor. | |
+ | AsioBase (Executor ex, Allocator alloc) |
Construct with associated I/O executor. | |
+ | AsioBase (const AsioBase &)=delete |
NOT copyable. | |
+AsioBase & | operator= (const AsioBase &)=delete |
+ | AsioBase (AsioBase &&) noexcept=default |
movable | |
+AsioBase & | operator= (AsioBase &&) noexcept=default |
Represents a FairMQ topology.
+Executor | Associated I/O executor |
Allocator | Associated default allocator |
+
|
+ +inline | +
(Re)Construct a FairMQ topology from an existing DDS topology
+topo | DDSTopology |
session | DDSSession |
+
|
+ +inline | +
(Re)Construct a FairMQ topology from an existing DDS topology
+ex | I/O executor to be associated |
topo | DDSTopology |
session | DDSSession |
RuntimeError |
+
|
+ +inline | +
Initiate state transition on all FairMQ devices in this topology.
+transition | FairMQ device state machine transition |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate state transition on all FairMQ devices in this topology.
+transition | FairMQ device state machine transition |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate state transition on all FairMQ devices in this topology with a timeout.
+transition | FairMQ device state machine transition |
timeout | Timeout in milliseconds, 0 means no timeout |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate state transition on all FairMQ devices in this topology with a timeout.
+transition | FairMQ device state machine transition |
path | Select a subset of FairMQ devices in this topology, empty selects all |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate property query on selected FairMQ devices in this topology.
+query | Key(s) to be queried (regex) |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate property query on selected FairMQ devices in this topology.
+query | Key(s) to be queried (regex) |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate property update on selected FairMQ devices in this topology.
+props | Properties to set |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate property update on selected FairMQ devices in this topology.
+props | Properties to set |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate waiting for selected FairMQ devices to reach given last & current state in this topology.
+targetLastState | the target last device state to wait for |
targetCurrentState | the target device state to wait for |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate waiting for selected FairMQ devices to reach given last & current state in this topology.
+targetLastState | the target last device state to wait for |
targetCurrentState | the target device state to wait for |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Initiate waiting for selected FairMQ devices to reach given current state in this topology.
+targetCurrentState | the target device state to wait for |
token | Asio completion token |
CompletionToken | Asio completion token type |
std::system_error |
+
|
+ +inline | +
Perform state transition on FairMQ devices in this topology for a specified topology path.
+transition | FairMQ device state machine transition |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
std::system_error |
+
|
+ +inline | +
Perform state transition on all FairMQ devices in this topology with a timeout.
+transition | FairMQ device state machine transition |
timeout | Timeout in milliseconds, 0 means no timeout |
std::system_error |
+
|
+ +inline | +
Returns the current state of the topology.
+
+
|
+ +inline | +
Query properties on selected FairMQ devices in this topology.
+query | Key(s) to be queried (regex) |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
std::system_error |
+
|
+ +inline | +
Set properties on selected FairMQ devices in this topology.
+props | Properties to set |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
std::system_error |
+
|
+ +inline | +
Wait for selected FairMQ devices to reach given last & current state in this topology.
+targetLastState | the target last device state to wait for |
targetCurrentState | the target device state to wait for |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
std::system_error |
+
|
+ +inline | +
Wait for selected FairMQ devices to reach given current state in this topology.
+targetCurrentState | the target device state to wait for |
path | Select a subset of FairMQ devices in this topology, empty selects all |
timeout | Timeout in milliseconds, 0 means no timeout |
std::system_error |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::DDSAgent, including all inherited members.
+DDSAgent(DDSSession session, Id id, Pid pid, std::string path, std::string host, std::chrono::milliseconds startupTime, std::string username) (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inlineexplicit |
GetDDSPath() const (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inline |
GetHost() const (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inline |
GetId() const (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inline |
GetPid() const (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inline |
GetSession() const (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inline |
GetStartupTime() const (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inline |
GetUsername() const (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | inline |
Id typedef (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | |
operator<< (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent | friend |
Pid typedef (defined in fair::mq::sdk::DDSAgent) | fair::mq::sdk::DDSAgent |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Represents a DDS agent. + More...
+ +#include <>>
+Public Types | |
+using | Id = uint64_t |
+using | Pid = uint32_t |
+Public Member Functions | |
+ | DDSAgent (DDSSession session, Id id, Pid pid, std::string path, std::string host, std::chrono::milliseconds startupTime, std::string username) |
+DDSSession | GetSession () const |
+Id | GetId () const |
+Pid | GetPid () const |
+std::string | GetHost () const |
+std::string | GetDDSPath () const |
+std::chrono::milliseconds | GetStartupTime () const |
+std::string | GetUsername () const |
+Friends | |
+auto | operator<< (std::ostream &os, const DDSAgent &agent) -> std::ostream & |
Represents a DDS agent.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::DDSChannel, including all inherited members.
+Id typedef (defined in fair::mq::sdk::DDSChannel) | fair::mq::sdk::DDSChannel |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Types | |
+using | Id = std::uint64_t |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::DDSCollection, including all inherited members.
+DDSCollection(Id id) (defined in fair::mq::sdk::DDSCollection) | fair::mq::sdk::DDSCollection | inlineexplicit |
GetId() const (defined in fair::mq::sdk::DDSCollection) | fair::mq::sdk::DDSCollection | inline |
Id typedef (defined in fair::mq::sdk::DDSCollection) | fair::mq::sdk::DDSCollection | |
operator<< (defined in fair::mq::sdk::DDSCollection) | fair::mq::sdk::DDSCollection | friend |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Represents a DDS collection. + More...
+ +#include <>>
+Public Types | |
+using | Id = std::uint64_t |
+Public Member Functions | |
+ | DDSCollection (Id id) |
+Id | GetId () const |
+Friends | |
+auto | operator<< (std::ostream &os, const DDSCollection &collection) -> std::ostream & |
Represents a DDS collection.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::DDSEnvironment, including all inherited members.
+DDSEnvironment() (defined in fair::mq::sdk::DDSEnvironment) | fair::mq::sdk::DDSEnvironment | |
DDSEnvironment(Path) (defined in fair::mq::sdk::DDSEnvironment) | fair::mq::sdk::DDSEnvironment | explicit |
GetConfigHome() const -> Path (defined in fair::mq::sdk::DDSEnvironment) | fair::mq::sdk::DDSEnvironment | |
GetLocation() const -> Path (defined in fair::mq::sdk::DDSEnvironment) | fair::mq::sdk::DDSEnvironment | |
operator<< (defined in fair::mq::sdk::DDSEnvironment) | fair::mq::sdk::DDSEnvironment | friend |
Path typedef (defined in fair::mq::sdk::DDSEnvironment) | fair::mq::sdk::DDSEnvironment |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Sets up the DDS environment (object helper) + More...
+ +#include <fairmq/sdk/DDSSession.h>
+Classes | |
struct | Impl |
+Public Types | |
+using | Path = boost::filesystem::path |
+Public Member Functions | |
+ | DDSEnvironment (Path) |
+auto | GetLocation () const -> Path |
+auto | GetConfigHome () const -> Path |
+Friends | |
+auto | operator<< (std::ostream &os, DDSEnvironment env) -> std::ostream & |
Sets up the DDS environment (object helper)
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::DDSSession, including all inherited members.
+ActivateTopology(const Path &topoFile) -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
ActivateTopology(DDSTopology) -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
DDSSession(DDSEnvironment env=DDSEnvironment()) (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | explicit |
DDSSession(Id existing, DDSEnvironment env=DDSEnvironment()) (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | explicit |
DDSSession(std::shared_ptr< dds::tools_api::CSession > nativeSession, DDSEnv env={}) | fair::mq::sdk::DDSSession | explicit |
GetEnv() const -> DDSEnvironment (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
GetId() const -> Id (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
GetRMSConfig() const -> Path (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
GetRMSPlugin() const -> DDSRMSPlugin (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
GetTaskId(DDSChannel::Id) const -> DDSTask::Id (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
Id typedef (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
IsRunning() const -> bool (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
IsStoppedOnDestruction() const -> bool (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
operator<< (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | friend |
Path typedef (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
Quantity typedef (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
RequestAgentCount() -> AgentCount (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
RequestAgentInfo() -> std::vector< DDSAgent > (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
RequestCommanderInfo() -> CommanderInfo (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
RequestTaskInfo() -> std::vector< DDSTask > (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
SendCommand(const std::string &, const std::string &="") (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
SendCommand(const std::string &, DDSChannel::Id) (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
SetRMSConfig(Path) const -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
SetRMSPlugin(DDSRMSPlugin) -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
StartDDSService() (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
Stop() -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
StopOnDestruction(bool stop=true) -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
SubmitAgents(Quantity agents) -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
SubscribeToCommands(std::function< void(const std::string &msg, const std::string &condition, uint64_t senderId)>) (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
UnsubscribeFromCommands() (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
WaitForExecutingAgents(Quantity) -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
WaitForIdleAgents(Quantity) -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession | |
WaitForOnlyIdleAgents() -> void (defined in fair::mq::sdk::DDSSession) | fair::mq::sdk::DDSSession |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Represents a DDS session. + More...
+ +#include <fairmq/sdk/DDSSession.h>
+Classes | |
struct | AgentCount |
struct | CommanderInfo |
struct | Impl |
+Public Types | |
+using | Id = std::string |
+using | Quantity = std::uint32_t |
+using | Path = boost::filesystem::path |
+Public Member Functions | |
+ | DDSSession (DDSEnvironment env=DDSEnvironment()) |
+ | DDSSession (Id existing, DDSEnvironment env=DDSEnvironment()) |
DDSSession (std::shared_ptr< dds::tools_api::CSession > nativeSession, DDSEnv env={}) | |
Construct with already existing native DDS API objects. More... | |
+auto | GetEnv () const -> DDSEnvironment |
+auto | GetId () const -> Id |
+auto | GetRMSPlugin () const -> DDSRMSPlugin |
+auto | SetRMSPlugin (DDSRMSPlugin) -> void |
+auto | GetRMSConfig () const -> Path |
+auto | SetRMSConfig (Path) const -> void |
+auto | IsStoppedOnDestruction () const -> bool |
+auto | StopOnDestruction (bool stop=true) -> void |
+auto | IsRunning () const -> bool |
+auto | SubmitAgents (Quantity agents) -> void |
+auto | RequestAgentCount () -> AgentCount |
+auto | RequestAgentInfo () -> std::vector< DDSAgent > |
+auto | RequestTaskInfo () -> std::vector< DDSTask > |
+auto | RequestCommanderInfo () -> CommanderInfo |
+auto | WaitForIdleAgents (Quantity) -> void |
+auto | WaitForOnlyIdleAgents () -> void |
+auto | WaitForExecutingAgents (Quantity) -> void |
+auto | ActivateTopology (const Path &topoFile) -> void |
+auto | ActivateTopology (DDSTopology) -> void |
+auto | Stop () -> void |
+void | StartDDSService () |
+void | SubscribeToCommands (std::function< void(const std::string &msg, const std::string &condition, uint64_t senderId)>) |
+void | UnsubscribeFromCommands () |
+void | SendCommand (const std::string &, const std::string &="") |
+void | SendCommand (const std::string &, DDSChannel::Id) |
+auto | GetTaskId (DDSChannel::Id) const -> DDSTask::Id |
+Friends | |
+auto | operator<< (std::ostream &os, const DDSSession &session) -> std::ostream & |
Represents a DDS session.
+
+
|
+ +explicit | +
Construct with already existing native DDS API objects.
+nativeSession | Existing and initialized CSession (either via create() or attach()) |
env | Optional DDSEnv |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::DDSTask, including all inherited members.
+DDSTask(Id id, Id collectionId) (defined in fair::mq::sdk::DDSTask) | fair::mq::sdk::DDSTask | inlineexplicit |
GetCollectionId() const (defined in fair::mq::sdk::DDSTask) | fair::mq::sdk::DDSTask | inline |
GetId() const (defined in fair::mq::sdk::DDSTask) | fair::mq::sdk::DDSTask | inline |
Id typedef (defined in fair::mq::sdk::DDSTask) | fair::mq::sdk::DDSTask | |
operator<< (defined in fair::mq::sdk::DDSTask) | fair::mq::sdk::DDSTask | friend |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Represents a DDS task. + More...
+ +#include <>>
+Public Types | |
+using | Id = std::uint64_t |
+Public Member Functions | |
+ | DDSTask (Id id, Id collectionId) |
+Id | GetId () const |
+DDSCollection::Id | GetCollectionId () const |
+Friends | |
+auto | operator<< (std::ostream &os, const DDSTask &task) -> std::ostream & |
Represents a DDS task.
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::sdk::DDSTopology, including all inherited members.
+DDSTopology()=delete (defined in fair::mq::sdk::DDSTopology) | fair::mq::sdk::DDSTopology | |
DDSTopology(Path topoFile, DDSEnvironment env=DDSEnvironment()) | fair::mq::sdk::DDSTopology | explicit |
DDSTopology(dds::topology_api::CTopology nativeTopology, DDSEnv env={}) | fair::mq::sdk::DDSTopology | explicit |
GetCollections() const -> std::vector< DDSCollection > | fair::mq::sdk::DDSTopology | |
GetEnv() const -> DDSEnvironment | fair::mq::sdk::DDSTopology | |
GetName() const -> std::string | fair::mq::sdk::DDSTopology | |
GetNumRequiredAgents() const -> int | fair::mq::sdk::DDSTopology | |
GetTasks(const std::string &="") const -> std::vector< DDSTask > | fair::mq::sdk::DDSTopology | |
GetTopoFile() const -> Path | fair::mq::sdk::DDSTopology | |
operator<< (defined in fair::mq::sdk::DDSTopology) | fair::mq::sdk::DDSTopology | friend |
Path typedef (defined in fair::mq::sdk::DDSTopology) | fair::mq::sdk::DDSTopology |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Represents a DDS topology. + More...
+ +#include <fairmq/sdk/DDSTopology.h>
+Classes | |
struct | Impl |
+Public Types | |
+using | Path = boost::filesystem::path |
+Public Member Functions | |
DDSTopology (Path topoFile, DDSEnvironment env=DDSEnvironment()) | |
Construct from file. More... | |
DDSTopology (dds::topology_api::CTopology nativeTopology, DDSEnv env={}) | |
Construct with already existing native DDS API objects. More... | |
+auto | GetEnv () const -> DDSEnvironment |
Get associated DDS environment. | |
auto | GetTopoFile () const -> Path |
Get path to DDS topology xml, if it is known. More... | |
+auto | GetNumRequiredAgents () const -> int |
Get number of required agents for this topology. | |
+auto | GetTasks (const std::string &="") const -> std::vector< DDSTask > |
Get list of tasks in this topology, optionally matching provided path. | |
+auto | GetCollections () const -> std::vector< DDSCollection > |
Get list of tasks in this topology. | |
+auto | GetName () const -> std::string |
Get the name of the topology. | |
+Friends | |
+auto | operator<< (std::ostream &, const DDSTopology &) -> std::ostream & |
Represents a DDS topology.
+
+
|
+ +explicit | +
Construct from file.
+topoFile | DDS topology xml file |
env | DDS environment |
+
|
+ +explicit | +
Construct with already existing native DDS API objects.
+nativeTopology | Existing and initialized CTopology |
env | Optional DDSEnv |
auto fair::mq::sdk::DDSTopology::GetTopoFile | +( | +) | +const -> Path | +
Get path to DDS topology xml, if it is known.
+std::runtime_error |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::shmem::Manager, including all inherited members.
+CreateRegion(const size_t size, const int64_t userFlags, RegionCallback callback, const std::string &path="", int flags=0) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
DecrementDeviceCounter() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
GetDeviceCounter() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
GetRegion(const uint64_t id) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
GetRegionInfo() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
GetRegionInfoUnsafe() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
GetRegionUnsafe(const uint64_t id) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
IncrementDeviceCounter() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Interrupt() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | inline |
Interrupted() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | inline |
ManagementSegment() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | inline |
Manager(const std::string &id, size_t size) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Manager()=delete (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Manager(const Manager &)=delete (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
operator=(const Manager &)=delete (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Region (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | friend |
RegionEventsSubscription() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
RemoveRegion(const uint64_t id) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
RemoveSegments() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Resume() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | inline |
Segment() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | inline |
StartMonitor(const std::string &) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | static |
SubscribeToRegionEvents(RegionEventCallback callback) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
UnsubscribeFromRegionEvents() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
~Manager() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | Manager (const std::string &id, size_t size) |
+ | Manager (const Manager &)=delete |
+Manager | operator= (const Manager &)=delete |
+boost::interprocess::managed_shared_memory & | Segment () |
+boost::interprocess::managed_shared_memory & | ManagementSegment () |
+void | Interrupt () |
+void | Resume () |
+bool | Interrupted () |
+int | GetDeviceCounter () |
+int | IncrementDeviceCounter () |
+int | DecrementDeviceCounter () |
+std::pair< boost::interprocess::mapped_region *, uint64_t > | CreateRegion (const size_t size, const int64_t userFlags, RegionCallback callback, const std::string &path="", int flags=0) |
+Region * | GetRegion (const uint64_t id) |
+Region * | GetRegionUnsafe (const uint64_t id) |
+void | RemoveRegion (const uint64_t id) |
+std::vector< fair::mq::RegionInfo > | GetRegionInfo () |
+std::vector< fair::mq::RegionInfo > | GetRegionInfoUnsafe () |
+void | SubscribeToRegionEvents (RegionEventCallback callback) |
+void | UnsubscribeFromRegionEvents () |
+void | RegionEventsSubscription () |
+void | RemoveSegments () |
+Static Public Member Functions | |
+static void | StartMonitor (const std::string &) |
+Friends | |
+struct | Region |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::shmem::Message, including all inherited members.
+Copy(const fair::mq::Message &msg) override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | virtual |
FairMQMessage()=default (defined in FairMQMessage) | FairMQMessage | |
FairMQMessage(FairMQTransportFactory *factory) (defined in FairMQMessage) | FairMQMessage | inline |
GetData() const override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | virtual |
GetSize() const override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | inlinevirtual |
GetTransport() (defined in FairMQMessage) | FairMQMessage | inline |
GetType() const override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | inlinevirtual |
Message(Manager &manager, FairMQTransportFactory *factory=nullptr) (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | |
Message(Manager &manager, const size_t size, FairMQTransportFactory *factory=nullptr) (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | |
Message(Manager &manager, void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *factory=nullptr) (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | |
Message(Manager &manager, UnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *factory=nullptr) (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | |
Message(Manager &manager, MetaHeader &hdr, FairMQTransportFactory *factory=nullptr) (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | |
Message(const Message &)=delete (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | |
operator=(const Message &)=delete (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | |
Rebuild() override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | virtual |
Rebuild(const size_t size) override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | virtual |
Rebuild(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | virtual |
SetUsedSize(const size_t size) override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | virtual |
Socket (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message | friend |
~FairMQMessage() (defined in FairMQMessage) | FairMQMessage | inlinevirtual |
~Message() override (defined in fair::mq::shmem::Message) | fair::mq::shmem::Message |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | Message (Manager &manager, FairMQTransportFactory *factory=nullptr) |
+ | Message (Manager &manager, const size_t size, FairMQTransportFactory *factory=nullptr) |
+ | Message (Manager &manager, void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *factory=nullptr) |
+ | Message (Manager &manager, UnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *factory=nullptr) |
+ | Message (Manager &manager, MetaHeader &hdr, FairMQTransportFactory *factory=nullptr) |
+ | Message (const Message &)=delete |
+Message | operator= (const Message &)=delete |
+void | Rebuild () override |
+void | Rebuild (const size_t size) override |
+void | Rebuild (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override |
+void * | GetData () const override |
+size_t | GetSize () const override |
+bool | SetUsedSize (const size_t size) override |
+Transport | GetType () const override |
+void | Copy (const fair::mq::Message &msg) override |
![]() | |
+ | FairMQMessage (FairMQTransportFactory *factory) |
+FairMQTransportFactory * | GetTransport () |
+Friends | |
+class | Socket |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::shmem::Monitor, including all inherited members.
+CatchSignals() (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | |
Cleanup(const std::string &shmId) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | static |
Monitor(const std::string &shmId, bool selfDestruct, bool interactive, bool viewOnly, unsigned int timeoutInMS, bool runAsDaemon, bool cleanOnExit) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | |
Monitor(const Monitor &)=delete (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | |
operator=(const Monitor &)=delete (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | |
RemoveCondition(const std::string &) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | static |
RemoveFileMapping(const std::string &) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | static |
RemoveMutex(const std::string &) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | static |
RemoveObject(const std::string &) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | static |
RemoveQueue(const std::string &) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | static |
Run() (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | |
~Monitor() (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | virtual |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Classes | |
struct | DaemonPresent |
+Public Member Functions | |
+ | Monitor (const std::string &shmId, bool selfDestruct, bool interactive, bool viewOnly, unsigned int timeoutInMS, bool runAsDaemon, bool cleanOnExit) |
+ | Monitor (const Monitor &)=delete |
+Monitor | operator= (const Monitor &)=delete |
+void | CatchSignals () |
+void | Run () |
+Static Public Member Functions | |
+static void | Cleanup (const std::string &shmId) |
+static void | RemoveObject (const std::string &) |
+static void | RemoveFileMapping (const std::string &) |
+static void | RemoveQueue (const std::string &) |
+static void | RemoveMutex (const std::string &) |
+static void | RemoveCondition (const std::string &) |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::shmem::Poller, including all inherited members.
+CheckInput(const int index) override (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | virtual |
CheckInput(const std::string &channelKey, const int index) override (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | virtual |
CheckOutput(const int index) override (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | virtual |
CheckOutput(const std::string &channelKey, const int index) override (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | virtual |
operator=(const Poller &)=delete (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | |
Poll(const int timeout) override (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | virtual |
Poller(const std::vector< FairMQChannel > &channels) (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | |
Poller(const std::vector< FairMQChannel *> &channels) (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | |
Poller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | |
Poller(const Poller &)=delete (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | |
SetItemEvents(zmq_pollitem_t &item, const int type) (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller | |
~FairMQPoller() (defined in FairMQPoller) | FairMQPoller | inlinevirtual |
~Poller() override (defined in fair::mq::shmem::Poller) | fair::mq::shmem::Poller |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | Poller (const std::vector< FairMQChannel > &channels) |
+ | Poller (const std::vector< FairMQChannel *> &channels) |
+ | Poller (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) |
+ | Poller (const Poller &)=delete |
+Poller | operator= (const Poller &)=delete |
+void | SetItemEvents (zmq_pollitem_t &item, const int type) |
+void | Poll (const int timeout) override |
+bool | CheckInput (const int index) override |
+bool | CheckOutput (const int index) override |
+bool | CheckInput (const std::string &channelKey, const int index) override |
+bool | CheckOutput (const std::string &channelKey, const int index) override |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::shmem::Socket, including all inherited members.
+Bind(const std::string &address) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
Close() override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
Connect(const std::string &address) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocket(FairMQTransportFactory *fac) (defined in FairMQSocket) | FairMQSocket | inline |
GetBytesRx() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | inlinevirtual |
GetBytesTx() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | inlinevirtual |
GetConstant(const std::string &constant) (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | static |
GetId() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | inlinevirtual |
GetLinger() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
GetMessagesRx() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | inlinevirtual |
GetMessagesTx() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | inlinevirtual |
GetOption(const std::string &option, void *value, size_t *valueSize) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
GetRcvBufSize() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
GetRcvKernelSize() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
GetSndBufSize() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
GetSndKernelSize() const override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
GetSocket() const (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | inline |
GetTransport() (defined in FairMQSocket) | FairMQSocket | inline |
operator=(const Socket &)=delete (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | |
Receive(MessagePtr &msg, const int timeout=-1) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
Receive(std::vector< MessagePtr > &msgVec, const int timeout=-1) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | |
Receive(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
Send(MessagePtr &msg, const int timeout=-1) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
Send(std::vector< MessagePtr > &msgVec, const int timeout=-1) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | |
Send(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 (defined in FairMQSocket) | FairMQSocket | pure virtual |
SetLinger(const int value) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
SetOption(const std::string &option, const void *value, size_t valueSize) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
SetRcvBufSize(const int value) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
SetRcvKernelSize(const int value) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
SetSndBufSize(const int value) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
SetSndKernelSize(const int value) override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | virtual |
SetTransport(FairMQTransportFactory *transport) (defined in FairMQSocket) | FairMQSocket | inline |
Socket(Manager &manager, const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr, FairMQTransportFactory *fac=nullptr) (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | |
Socket(const Socket &)=delete (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | |
~FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inlinevirtual |
~Socket() override (defined in fair::mq::shmem::Socket) | fair::mq::shmem::Socket | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | Socket (Manager &manager, const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr, FairMQTransportFactory *fac=nullptr) |
+ | Socket (const Socket &)=delete |
+Socket | operator= (const Socket &)=delete |
+std::string | GetId () const override |
+bool | Bind (const std::string &address) override |
+bool | Connect (const std::string &address) override |
+int | Send (MessagePtr &msg, const int timeout=-1) override |
+int | Receive (MessagePtr &msg, const int timeout=-1) override |
+int64_t | Send (std::vector< MessagePtr > &msgVec, const int timeout=-1) override |
+int64_t | Receive (std::vector< MessagePtr > &msgVec, const int timeout=-1) override |
+void * | GetSocket () const |
+void | Close () override |
+void | SetOption (const std::string &option, const void *value, size_t valueSize) override |
+void | GetOption (const std::string &option, void *value, size_t *valueSize) override |
+void | SetLinger (const int value) override |
+int | GetLinger () const override |
+void | SetSndBufSize (const int value) override |
+int | GetSndBufSize () const override |
+void | SetRcvBufSize (const int value) override |
+int | GetRcvBufSize () const override |
+void | SetSndKernelSize (const int value) override |
+int | GetSndKernelSize () const override |
+void | SetRcvKernelSize (const int value) override |
+int | GetRcvKernelSize () const override |
+unsigned long | GetBytesTx () const override |
+unsigned long | GetBytesRx () const override |
+unsigned long | GetMessagesTx () const override |
+unsigned long | GetMessagesRx () const override |
![]() | |
+ | FairMQSocket (FairMQTransportFactory *fac) |
+virtual int64_t | Send (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 |
+virtual int64_t | Receive (std::vector< std::unique_ptr< FairMQMessage >> &msgVec, int timeout=-1)=0 |
+FairMQTransportFactory * | GetTransport () |
+void | SetTransport (FairMQTransportFactory *transport) |
+Static Public Member Functions | |
+static int | GetConstant (const std::string &constant) |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::shmem::TransportFactory, including all inherited members.
+CreateMessage() override | fair::mq::shmem::TransportFactory | virtual |
CreateMessage(const size_t size) override | fair::mq::shmem::TransportFactory | virtual |
CreateMessage(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override | fair::mq::shmem::TransportFactory | virtual |
CreateMessage(UnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) override | fair::mq::shmem::TransportFactory | virtual |
CreatePoller(const std::vector< FairMQChannel > &channels) const override | fair::mq::shmem::TransportFactory | virtual |
CreatePoller(const std::vector< FairMQChannel *> &channels) const override | fair::mq::shmem::TransportFactory | virtual |
CreatePoller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override | fair::mq::shmem::TransportFactory | virtual |
CreateSocket(const std::string &type, const std::string &name) override | fair::mq::shmem::TransportFactory | virtual |
CreateTransportFactory(const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const override | fair::mq::shmem::TransportFactory | virtual |
CreateUnmanagedRegion(const size_t size, int64_t userFlags, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const override | fair::mq::shmem::TransportFactory | virtual |
DecrementMsgCounter() (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | inline |
FairMQNoCleanup(void *, void *) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQSimpleMsgCleanup(void *, void *obj) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQTransportFactory(const std::string &id) | FairMQTransportFactory | |
GetId() const -> const std::string (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
GetMemoryResource() | FairMQTransportFactory | inline |
GetRegionInfo() override (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | virtual |
GetType() const override | fair::mq::shmem::TransportFactory | virtual |
IncrementMsgCounter() (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | inline |
Interrupt() override (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | inlinevirtual |
NewSimpleMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const char(&data)[N]) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewSimpleMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const T &data) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
NewStaticMessage(const std::string &str) (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator fair::mq::ChannelResource *() (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
operator=(const TransportFactory &)=delete (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | |
Reset() override (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | virtual |
Resume() override (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | inlinevirtual |
SubscribeToRegionEvents(RegionEventCallback callback) override | fair::mq::shmem::TransportFactory | virtual |
TransportFactory(const std::string &id="", const ProgOptions *config=nullptr) (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | |
TransportFactory(const TransportFactory &)=delete (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory | |
UnsubscribeFromRegionEvents() override | fair::mq::shmem::TransportFactory | virtual |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
~TransportFactory() override (defined in fair::mq::shmem::TransportFactory) | fair::mq::shmem::TransportFactory |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | TransportFactory (const std::string &id="", const ProgOptions *config=nullptr) |
+ | TransportFactory (const TransportFactory &)=delete |
+TransportFactory | operator= (const TransportFactory &)=delete |
MessagePtr | CreateMessage () override |
Create empty FairMQMessage. More... | |
MessagePtr | CreateMessage (const size_t size) override |
Create new FairMQMessage of specified size. More... | |
MessagePtr | CreateMessage (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override |
Create new FairMQMessage with user provided buffer and size. More... | |
MessagePtr | CreateMessage (UnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) override |
create a message with the buffer located within the corresponding unmanaged region More... | |
+SocketPtr | CreateSocket (const std::string &type, const std::string &name) override |
Create a socket. | |
+PollerPtr | CreatePoller (const std::vector< FairMQChannel > &channels) const override |
Create a poller for a single channel (all subchannels) | |
+PollerPtr | CreatePoller (const std::vector< FairMQChannel *> &channels) const override |
Create a poller for specific channels. | |
+PollerPtr | CreatePoller (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override |
Create a poller for specific channels (all subchannels) | |
UnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const override |
Create new UnmanagedRegion. More... | |
UnmanagedRegionPtr | CreateUnmanagedRegion (const size_t size, int64_t userFlags, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const override |
Create new UnmanagedRegion. More... | |
void | SubscribeToRegionEvents (RegionEventCallback callback) override |
Subscribe to region events (creation, destruction, ...) More... | |
+void | UnsubscribeFromRegionEvents () override |
Unsubscribe from region events. | |
+std::vector< fair::mq::RegionInfo > | GetRegionInfo () override |
+Transport | GetType () const override |
Get transport type. | |
+void | Interrupt () override |
+void | Resume () override |
+void | Reset () override |
+void | IncrementMsgCounter () |
+void | DecrementMsgCounter () |
![]() | |
FairMQTransportFactory (const std::string &id) | |
+auto | GetId () const -> const std::string |
+fair::mq::ChannelResource * | GetMemoryResource () |
Get a pointer to the associated polymorphic memory resource. | |
+ | operator fair::mq::ChannelResource * () |
+template<typename T > | |
FairMQMessagePtr | NewSimpleMessage (const T &data) |
+template<std::size_t N> | |
FairMQMessagePtr | NewSimpleMessage (const char(&data)[N]) |
+FairMQMessagePtr | NewSimpleMessage (const std::string &str) |
+template<typename T > | |
FairMQMessagePtr | NewStaticMessage (const T &data) |
+FairMQMessagePtr | NewStaticMessage (const std::string &str) |
+Additional Inherited Members | |
![]() | |
+static auto | CreateTransportFactory (const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > |
+static void | FairMQNoCleanup (void *, void *) |
+template<typename T > | |
static void | FairMQSimpleMsgCleanup (void *, void *obj) |
+
|
+ +overridevirtual | +
Create empty FairMQMessage.
+Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new FairMQMessage of specified size.
+size | message size |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new FairMQMessage with user provided buffer and size.
+data | pointer to user provided buffer |
size | size of the user provided buffer |
ffn | callback, called when the message is transfered (and can be deleted) |
obj | optional helper pointer that can be used in the callback |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
create a message with the buffer located within the corresponding unmanaged region
+unmanagedRegion | the unmanaged region that this message buffer belongs to |
data | message buffer (must be within the region - checked at runtime by the transport) |
size | size of the message |
hint | optional parameter, returned to the user in the FairMQRegionCallback |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Create new UnmanagedRegion.
+size | size of the region |
userFlags | flags to be stored with the region, have no effect on the transport, but can be retrieved from the region by the user |
callback | callback to be called when a message belonging to this region is no longer needed by the transport |
path | optional parameter to pass to the underlying transport |
flags | optional parameter to pass to the underlying transport |
Implements FairMQTransportFactory.
+ +
+
|
+ +overridevirtual | +
Subscribe to region events (creation, destruction, ...)
+callback | the callback that is called when a region event occurs |
Implements FairMQTransportFactory.
+ +
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::shmem::UnmanagedRegion, including all inherited members.
+GetData() const override (defined in fair::mq::shmem::UnmanagedRegion) | fair::mq::shmem::UnmanagedRegion | inlinevirtual |
GetSize() const override (defined in fair::mq::shmem::UnmanagedRegion) | fair::mq::shmem::UnmanagedRegion | inlinevirtual |
Message (defined in fair::mq::shmem::UnmanagedRegion) | fair::mq::shmem::UnmanagedRegion | friend |
Socket (defined in fair::mq::shmem::UnmanagedRegion) | fair::mq::shmem::UnmanagedRegion | friend |
UnmanagedRegion(Manager &manager, const size_t size, RegionCallback callback, const std::string &path="", int flags=0) (defined in fair::mq::shmem::UnmanagedRegion) | fair::mq::shmem::UnmanagedRegion | inline |
UnmanagedRegion(Manager &manager, const size_t size, const int64_t userFlags, RegionCallback callback, const std::string &path="", int flags=0) (defined in fair::mq::shmem::UnmanagedRegion) | fair::mq::shmem::UnmanagedRegion | inline |
~FairMQUnmanagedRegion() (defined in FairMQUnmanagedRegion) | FairMQUnmanagedRegion | inlinevirtual |
~UnmanagedRegion() override (defined in fair::mq::shmem::UnmanagedRegion) | fair::mq::shmem::UnmanagedRegion | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Public Member Functions | |
+ | UnmanagedRegion (Manager &manager, const size_t size, RegionCallback callback, const std::string &path="", int flags=0) |
+ | UnmanagedRegion (Manager &manager, const size_t size, const int64_t userFlags, RegionCallback callback, const std::string &path="", int flags=0) |
+void * | GetData () const override |
+size_t | GetSize () const override |
+Friends | |
+class | Message |
+class | Socket |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for fair::mq::tools::RateLimiter, including all inherited members.
+maybe_sleep() | fair::mq::tools::RateLimiter | inline |
RateLimiter(float rate) | fair::mq::tools::RateLimiter | inlineexplicit |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
#include <RateLimit.h>
+Public Member Functions | |
RateLimiter (float rate) | |
void | maybe_sleep () |
Objects of type RateLimiter can be used to limit a loop to a given rate of iterations per second.
+Example:
+
|
+ +inlineexplicit | +
Constructs a rate limiter.
+rate | Work rate in Hz (calls to maybe_sleep per second). Values less than/equal to 0 set the rate to 1 GHz (which is impossible to achieve, even with a loop that only calls RateLimiter::maybe_sleep). |
+
|
+ +inline | +
Call this function at the end of the iteration rate limited loop.
+This function might use std::this_thread::sleep_for
to limit the iteration rate. If no sleeps are necessary, the function will back off checking for the time to further allow increased iteration rates (until the requested rate or 1s between rechecks is reached).
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This is the complete list of members for pmix::Commands, including all inherited members.
+Commands(const proc &process) (defined in pmix::Commands) | pmix::Commands | inline |
Send(const std::string &msg) (defined in pmix::Commands) | pmix::Commands | inline |
Send(const std::string &msg, rank rank) (defined in pmix::Commands) | pmix::Commands | inline |
Send(const std::string &msg, const std::vector< proc > &destination) (defined in pmix::Commands) | pmix::Commands | inline |
Subscribe(std::function< void(const std::string &msg, const proc &sender)> callback) (defined in pmix::Commands) | pmix::Commands | inline |
Unsubscribe() (defined in pmix::Commands) | pmix::Commands | inline |
~Commands() (defined in pmix::Commands) | pmix::Commands | inline |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Classes | |
struct | Holder |
+Public Member Functions | |
+ | Commands (const proc &process) |
+void | Subscribe (std::function< void(const std::string &msg, const proc &sender)> callback) |
+void | Unsubscribe () |
+void | Send (const std::string &msg) |
+void | Send (const std::string &msg, rank rank) |
+void | Send (const std::string &msg, const std::vector< proc > &destination) |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+Directories |
+Files | |
file | SuboptParser.cxx |
Parser implementation for key-value subopt format. | |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
▼ fairmq | |
▼ devices | |
FairMQBenchmarkSampler.h | |
FairMQMerger.h | |
FairMQMultiplier.h | |
FairMQProxy.h | |
FairMQSink.h | |
FairMQSplitter.h | |
▼ nanomsg | |
FairMQMessageNN.h | |
FairMQPollerNN.h | |
FairMQSocketNN.h | |
FairMQTransportFactoryNN.h | |
FairMQUnmanagedRegionNN.h | |
▼ ofi | |
Context.h | |
ControlMessages.h | |
Message.h | |
Poller.h | |
Socket.h | |
TransportFactory.h | |
▼ options | |
FairMQProgOptions.h | |
▼ plugins | |
► config | |
► DDS | |
► PMIx | |
Builtin.h | |
Control.h | |
▼ sdk | |
► commands | |
AsioAsyncOp.h | |
AsioBase.h | |
DDSAgent.h | |
DDSCollection.h | |
DDSEnvironment.h | |
DDSSession.h | |
DDSTask.h | |
DDSTopology.h | |
Error.h | |
Topology.h | |
Traits.h | |
▼ shmem | |
Common.h | |
Manager.h | |
Message.h | |
Monitor.h | |
Poller.h | |
Region.h | |
Socket.h | |
TransportFactory.h | |
UnmanagedRegion.h | |
▼ tools | |
CppSTL.h | |
InstanceLimit.h | |
Network.h | |
Process.h | |
RateLimit.h | |
Semaphore.h | |
Strings.h | |
Unique.h | |
Version.h | |
▼ zeromq | |
FairMQMessageZMQ.h | |
FairMQPollerZMQ.h | |
FairMQSocketZMQ.h | |
FairMQTransportFactoryZMQ.h | |
FairMQUnmanagedRegionZMQ.h | |
DeviceRunner.h | |
EventManager.h | |
FairMQChannel.h | |
FairMQDevice.h | |
FairMQLogger.h | |
FairMQMessage.h | |
FairMQParts.h | |
FairMQPoller.h | |
FairMQSocket.h | |
FairMQTransportFactory.h | |
FairMQUnmanagedRegion.h | |
JSONParser.h | |
MemoryResources.h | |
MemoryResourceTools.h | |
Plugin.h | |
PluginManager.h | |
PluginServices.h | |
ProgOptions.h | |
ProgOptionsFwd.h | |
Properties.h | |
PropertyOutput.h | |
runFairMQDevice.h | |
SDK.h | |
StateMachine.h | |
StateQueue.h | |
States.h | |
SuboptParser.cxx | Parser implementation for key-value subopt format |
SuboptParser.h | |
Tools.h | |
Transports.h |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
+
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
Cfair::mq::ofi::Address | |
Cfair::mq::sdk::DDSSession::AgentCount | |
Cfair::mq::sdk::AsioAsyncOp< Executor, Allocator, CompletionSignature > | Interface for Asio-compliant asynchronous operation, see https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html |
Cfair::mq::sdk::AsioAsyncOp< Executor, Allocator, ChangeStateCompletionSignature > | |
Cfair::mq::sdk::AsioAsyncOp< Executor, Allocator, GetPropertiesCompletionSignature > | |
Cfair::mq::sdk::AsioAsyncOp< Executor, Allocator, SetPropertiesCompletionSignature > | |
Cfair::mq::sdk::AsioAsyncOp< Executor, Allocator, SignatureReturnType(SignatureFirstArgType, SignatureArgTypes...)> | |
Cfair::mq::sdk::AsioAsyncOp< Executor, Allocator, WaitForStateCompletionSignature > | |
Cfair::mq::sdk::AsioAsyncOpImplBase< SignatureArgTypes > | |
►Cfair::mq::sdk::AsioAsyncOpImplBase< SignatureArgTypes... > | |
►Cfair::mq::sdk::AsioBase< Executor, Allocator > | Base for creating Asio-enabled I/O objects |
Casio::detail::associated_allocator_impl< T, Allocator, std::enable_if_t< T::AllocatorType > > | Specialize to match our coding conventions |
Casio::detail::associated_executor_impl< T, Executor, std::enable_if_t< is_executor< typename T::ExecutorType >::value > > | Specialize to match our coding conventions |
Cfair::mq::fsm::AUTO_E | |
Cfair::mq::fsm::BIND_E | |
►Cfair::mq::sdk::cmd::Cmd | |
Cfair::mq::sdk::cmd::Cmds | |
Cfair::mq::sdk::DDSSession::CommanderInfo | |
Cpmix::Commands | |
Cfair::mq::fsm::COMPLETE_INIT_E | |
Cfair::mq::fsm::CONNECT_E | |
Cfair::mq::ofi::Context | Transport-wide context |
Cfair::mq::ofi::ControlMessage | |
Cfair::mq::ofi::ControlMessageContent | |
Cfair::mq::sdk::DDSAgent | Represents a DDS agent |
Cfair::mq::sdk::DDSChannel | |
Cfair::mq::sdk::DDSCollection | Represents a DDS collection |
Cfair::mq::plugins::DDSConfig | |
Cfair::mq::sdk::DDSEnvironment | Sets up the DDS environment (object helper) |
Cfair::mq::sdk::DDSSession | Represents a DDS session |
Cfair::mq::plugins::DDSSubscription | |
Cfair::mq::sdk::DDSTask | Represents a DDS task |
Cfair::mq::sdk::DDSTopology | Represents a DDS topology |
Cfair::mq::fsm::Machine_::DefaultFct | |
Cfair::mq::sdk::GetPropertiesResult::Device | |
Cfair::mq::shmem::DeviceCounter | |
Cfair::mq::DeviceRunner | Utility class to facilitate a convenient top-level device launch/shutdown |
Cfair::mq::sdk::DeviceStatus | |
Cfair::mq::ofi::Empty | |
Cfair::mq::fsm::END_E | |
►Cerror_category | |
Cfair::mq::fsm::ERROR_FOUND_E | |
Cfair::mq::Event< K > | |
►Cfair::mq::Event< DeviceRunner &> | |
►Cfair::mq::Event< std::string > | |
Cfair::mq::EventManager | Manages event callbacks from different subscribers |
Cfair::mq::tools::execute_result | |
CFairMQChannel | |
►CFairMQDevice | |
►CFairMQMessage | |
CFairMQParts | FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage, used for sending multi-part messages |
►CFairMQPoller | |
CFairMQRegionInfo | |
►CFairMQSocket | |
►CFairMQTransportFactory | |
►CFairMQUnmanagedRegion | |
Cfair::mq::sdk::GetPropertiesResult | |
Cfair::mq::tools::HashEnum< Enum > | |
►Cfair::mq::tools::HashEnum< fair::mq::Transport > | |
Cpmix::Commands::Holder | |
Cfair::mq::sdk::DDSEnvironment::Impl | |
Cfair::mq::sdk::DDSSession::Impl | |
Cfair::mq::sdk::DDSTopology::Impl | |
Cfair::mq::fsm::INIT_DEVICE_E | |
Cfair::mq::fsm::INIT_TASK_E | |
Cfair::mq::tools::InstanceLimiter< Tag, Max > | |
Cfair::mq::tools::InstanceLimiter< fair::mq::sdk::DDSEnvironment::Impl::Tag, 1 > | |
Cfair::mq::tools::InstanceLimiter< fair::mq::sdk::DDSSession::Impl::Tag, 1 > | |
►Cinvalid_argument | |
Cfair::mq::plugins::IofN | |
CLinePrinter | |
Cfair::mq::shmem::Manager | |
►Cmemory_resource | |
Cfair::mq::shmem::MetaHeader | |
CMiniTopo | |
Cfair::mq::shmem::Monitor | |
►Cfair::mq::Plugin | Base class for FairMQ plugins |
Cfair::mq::PluginManager | Manages and owns plugin instances |
Cfair::mq::PluginServices | Facilitates communication between devices and plugins |
►Cpmix_info_t | |
►Cpmix_pdata_t | |
►Cpmix_proc_t | |
►Cpmix_value_t | |
Cfair::mq::ofi::PostBuffer | |
Cfair::mq::ofi::PostMultiPartStartBuffer | |
Cfair::mq::ProgOptions | |
Cfair::mq::PropertyHelper | |
Cpmix::rank | |
Cfair::mq::tools::RateLimiter | |
Cfair::mq::shmem::Region | |
Cfair::mq::shmem::RegionBlock | |
Cfair::mq::shmem::RegionCounter | |
Cfair::mq::shmem::RegionInfo | |
Cfair::mq::fsm::RESET_DEVICE_E | |
Cfair::mq::fsm::RESET_TASK_E | |
Cfair::mq::fsm::RUN_E | |
►Cruntime_error | |
Cfair::mq::tools::Semaphore | A simple blocking semaphore |
Cfair::mq::tools::SharedSemaphore | A simple copyable blocking semaphore |
►Cstate | |
►Cstate_machine_def | |
Cfair::mq::StateMachine | |
Cfair::mq::StateQueue | |
CStateSubscription | |
Cfair::mq::fsm::STOP_E | |
Cfair::mq::sdk::DDSEnvironment::Impl::Tag | |
Cfair::mq::sdk::DDSSession::Impl::Tag | |
Cfair::mq::plugins::terminal_config | |
Cfair::mq::shmem::TerminalConfig | |
CTerminalConfig | |
►Cterminate_state | |
►Ctrue_type | |
CValInfo | |
►Cvector | |
Cfair::mq::tools::Version | |
Cfair::mq::shmem::ZMsg |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
C++ Message Queuing Library and Framework
+Release | Version | Docs |
---|---|---|
stable | API, Book | |
testing | Book |
Find all FairMQ releases here.
+FairMQ is designed to help implementing large-scale data processing workflows needed in next-generation Particle Physics experiments. FairMQ is written in C++ and aims to
The core of FairMQ provides an abstract asynchronous message passing API with scalability protocols inspired by ZeroMQ (e.g. PUSH/PULL, PUB/SUB). FairMQ provides multiple implementations for its API (so-called "transports", e.g. zeromq
, shmem
, nanomsg
, and ofi
(in development)) to cover a variety of use cases (e.g. inter-thread, inter-process, inter-node communication) and machines (e.g. Ethernet, Infiniband). In addition to this core functionality FairMQ provides a framework for creating "devices" - actors which are communicating through message passing. FairMQ does not only allow the user to use different transport but also to mix them; i.e: A Device can communicate using different transport on different channels at the same time. Device execution is modelled as a simple state machine that shapes the integration points for the user task. Devices also incorporate a plugin system for runtime configuration and control. Next to the provided devices and plugins (e.g. DDS) the user can extend FairMQ by developing his own plugins to integrate his devices with external configuration and control services.
FairMQ has been developed in the context of its mother project FairRoot - a simulation, reconstruction and analysis framework.
+Recommended:
+Please consult the manpages of your CMake version for more options.
+If dependencies are not installed in standard system directories, you can hint the installation location via -DCMAKE_PREFIX_PATH=...
or per dependency via -D{DEPENDENCY}_ROOT=...
. {DEPENDENCY}
can be GTEST
, BOOST
, FAIRLOGGER
, ZEROMQ
, MSGPACK
, NANOMSG
, OFI
, PMIX
, ASIO
, ASIOFI
or DDS
(*_ROOT
variables can also be environment variables).
FairMQ ships as a CMake package, so in your CMakeLists.txt
you can discover it like this:
If FairMQ is not installed in system directories, you can hint the installation:
+find_package(FairMQ)
will define an imported target FairMQ::FairMQ
.
In order to succesfully compile and link against the FairMQ::FairMQ
target, you need to discover its public package dependencies:
If your project shares a dependency with FairMQ or if you want to omit a certain dependency, you may want to customize the above example code to your needs.
+Optionally, you can require certain FairMQ package components and a minimum version:
+When building FairMQ, CMake will print a summary table of all available package components.
+Which dependencies are required depends on which components are built.
+Supported platforms: Linux and MacOS.
+On command line:
+-DDISABLE_COLOR=ON
disables coloured console output.-DBUILD_TESTING=OFF
disables building of tests.-DBUILD_EXAMPLES=OFF
disables building of examples.-DBUILD_NANOMSG_TRANSPORT=ON
enables building of nanomsg transport.-DBUILD_OFI_TRANSPORT=ON
enables building of the experimental OFI transport.-DBUILD_DDS_PLUGIN=ON
enables building of the DDS plugin.-DBUILD_PMIX_PLUGIN=ON
enables building of the PMIx plugin.-DBUILD_DOCS=ON
enables building of API docs.After the find_package(FairMQ)
call the following CMake variables are defined:
Variable | Info |
---|---|
${FairMQ_PACKAGE_DEPENDENCIES} | the list of public package dependencies |
${FairMQ_Boost_VERSION} | the minimum Boost version FairMQ requires |
${FairMQ_Boost_COMPONENTS} | the list of Boost components FairMQ depends on |
${FairMQ_FairLogger_VERSION} | the minimum FairLogger version FairMQ requires |
${FairMQ_PACKAGE_COMPONENTS} | the list of components FairMQ consists of |
${FairMQ_::COMPONENT::_FOUND} | TRUE if this component was built |
${FairMQ_VERSION} | the version in format MAJOR.MINOR.PATCH |
${FairMQ_GIT_VERSION} | the version in the format returned by git describe --tags --dirty --match "v*" |
${FairMQ_PREFIX} | the actual installation prefix |
${FairMQ_BINDIR} | the installation bin directory |
${FairMQ_INCDIR} | the installation include directory |
${FairMQ_LIBDIR} | the installation lib directory |
${FairMQ_DATADIR} | the installation data directory (../share/fairmq ) |
${FairMQ_CMAKEMODDIR} | the installation directory of shipped CMake find modules |
${FairMQ_CXX_STANDARD_REQUIRED} | the value of CMAKE_CXX_STANDARD_REQUIRED at build-time |
${FairMQ_CXX_STANDARD} | the value of CMAKE_CXX_STANDARD at build-time |
${FairMQ_CXX_EXTENSIONS} | the values of CMAKE_CXX_EXTENSIONS at build-time |
${FairMQ_BUILD_TYPE} | the value of CMAKE_BUILD_TYPE at build-time |
${FairMQ_CXX_FLAGS} | the values of CMAKE_CXX_FLAGS and CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE} at build-time |
+ FairMQ
+ 1.4.14
+
+ C++ Message Queuing Library and Framework
+ |
+
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
t |