diff --git a/latest b/latest index 4c8a05a6..8185624e 120000 --- a/latest +++ b/latest @@ -1 +1 @@ -v1.3.8 \ No newline at end of file +v1.3.9 \ No newline at end of file diff --git a/v1.3.9/Builtin_8h_source.html b/v1.3.9/Builtin_8h_source.html new file mode 100644 index 00000000..b16cff2f --- /dev/null +++ b/v1.3.9/Builtin_8h_source.html @@ -0,0 +1,75 @@ + + +
+ + + + +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
Parser implementation for key-value subopt format. +More...
+#include "FairMQSuboptParser.h"
#include <boost/property_tree/ptree.hpp>
#include <cstring>
#include <utility>
+Namespaces | |
fair | |
Tools for interfacing containers to the transport via polymorphic allocators. | |
Parser implementation for key-value subopt format.
+ +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
Parser implementation for key-value subopt format. +More...
+#include "FairMQParser.h"
#include <boost/program_options.hpp>
#include <cstring>
#include <vector>
#include <string>
Go to the source code of this file.
++Classes | |
struct | fair::mq::parser::SUBOPT |
+Namespaces | |
fair | |
Tools for interfacing containers to the transport via polymorphic allocators. | |
Parser implementation for key-value subopt format.
+ +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
▼Nfair | Tools for interfacing containers to the transport via polymorphic allocators |
▼Nmq | |
►Nfsm | |
►Nhooks | |
►Nofi | |
►Noptions | |
►Nparser | |
►Nplugins | |
►Nshmem | |
►Ntools | |
CChannelResource | |
CConvertVariableValue | |
CDeviceRunner | Utility class to facilitate a convenient top-level device launch/shutdown |
CEvent | |
CEventManager | Manages event callbacks from different subscribers |
CFairMQMemoryResource | |
CMessageError | |
CPlugin | Base class for FairMQ plugins |
►CPluginManager | Manages and owns plugin instances |
►CPluginServices | Facilitates communication between devices and plugins |
CPollerError | |
CPropertyChange | |
CPropertyChangeAsString | |
CSocketError | |
►CStateMachine | Implements the state machine for FairMQ devices |
CTransportFactoryError | |
CVarValInfo | |
▼Nstd | |
Chash< fair::mq::Transport > | |
Chash< FairMQStateMachine::Event > | |
CFairMQBenchmarkSampler | |
▼CFairMQChannel | |
CChannelConfigurationError | |
CFairMQDevice | |
CFairMQMerger | |
CFairMQMessage | |
CFairMQMessageNN | |
CFairMQMessageSHM | |
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 | |
CFairMQPollerSHM | |
CFairMQPollerZMQ | |
CFairMQProgOptions | |
CFairMQProxy | |
CFairMQSink | |
CFairMQSocket | |
CFairMQSocketNN | |
CFairMQSocketSHM | |
CFairMQSocketZMQ | |
CFairMQSplitter | |
CFairMQStateMachine | |
CFairMQTransportFactory | |
CFairMQTransportFactoryNN | |
CFairMQTransportFactorySHM | |
CFairMQTransportFactoryZMQ | |
CFairMQUnmanagedRegion | |
CFairMQUnmanagedRegionNN | |
CFairMQUnmanagedRegionSHM | |
CFairMQUnmanagedRegionZMQ | |
CMyDevice |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQBenchmarkSampler, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQBenchmarkSampler() (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() override | FairMQBenchmarkSampler | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Pause() | FairMQDevice | protectedvirtual |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() override | FairMQBenchmarkSampler | protectedvirtual |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (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 |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQBenchmarkSampler() (defined in FairMQBenchmarkSampler) | FairMQBenchmarkSampler | virtual |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | 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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
+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. | |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
![]() | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
![]() | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | fConfig |
Pointer to config (internal or external) | |
Sampler to generate traffic for benchmarking.
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | |
FairMQChannel() | 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 FairMQChannel &) | 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 | FairMQChannel | inline |
GetChannelName() const | FairMQChannel | inline |
GetChannelPrefix() const | 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 | |
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 |
of (defined in FairMQChannel) | FairMQChannel | |
of (defined in FairMQChannel) | FairMQChannel | |
operator=(const FairMQChannel &) | FairMQChannel | |
Receive(FairMQMessagePtr &msg, int rcvTimeoutInMs=-1) | FairMQChannel | inline |
Receive(msg, 0) (defined in FairMQChannel) | FairMQChannel | |
Receive(std::vector< FairMQMessagePtr > &msgVec, int rcvTimeoutInMs=-1) | FairMQChannel | inline |
Receive(msgVec, 0) (defined in FairMQChannel) | FairMQChannel | |
Receive(FairMQParts &parts, int rcvTimeoutInMs=-1) | FairMQChannel | inline |
ReceiveAsync(FairMQMessagePtr &msg) __attribute__((deprecated("For non-blocking Receive (defined in FairMQChannel) | FairMQChannel | |
ReceiveAsync(std::vector< FairMQMessagePtr > &msgVec) __attribute__((deprecated("For non-blocking Receive (defined in FairMQChannel) | FairMQChannel | |
ReceiveAsync(FairMQParts &parts) __attribute__((deprecated("For non-blocking Receive (defined in FairMQChannel) | FairMQChannel | |
ResetChannel() | FairMQChannel | |
Send(FairMQMessagePtr &msg, int sndTimeoutInMs=-1) | FairMQChannel | inline |
Send(msg, 0) (defined in FairMQChannel) | FairMQChannel | |
Send(std::vector< FairMQMessagePtr > &msgVec, int sndTimeoutInMs=-1) | FairMQChannel | inline |
Send(msgVec, 0) (defined in FairMQChannel) | FairMQChannel | |
Send(FairMQParts &parts, int sndTimeoutInMs=-1) | FairMQChannel | inline |
SendAsync(FairMQMessagePtr &msg) __attribute__((deprecated("For non-blocking Send (defined in FairMQChannel) | FairMQChannel | |
SendAsync(std::vector< FairMQMessagePtr > &msgVec) __attribute__((deprecated("For non-blocking Send (defined in FairMQChannel) | FairMQChannel | |
SendAsync(FairMQParts &parts) __attribute__((deprecated("For non-blocking Send (defined in FairMQChannel) | FairMQChannel | |
timeout (defined in FairMQChannel) | FairMQChannel | |
timeout (defined in FairMQChannel) | FairMQChannel | |
Transport() -> FairMQTransportFactory * (defined in FairMQChannel) | FairMQChannel | inline |
UpdateAddress(const std::string &address) | FairMQChannel | |
UpdateAutoBind(const bool autobind) | FairMQChannel | |
UpdateChannelName(const std::string &name) | 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() | FairMQChannel | inline |
~FairMQChannel() | FairMQChannel | inlinevirtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Classes | |
struct | ChannelConfigurationError |
+Public Member Functions | |
+ | FairMQChannel () |
Default constructor. | |
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 FairMQChannel &) |
Copy Constructor. | |
+FairMQChannel & | operator= (const FairMQChannel &) |
Assignment operator. | |
+virtual | ~FairMQChannel () |
Default destructor. | |
+FairMQSocket & | GetSocket () const |
+bool | Bind (const std::string &address) |
+bool | Connect (const std::string &address) |
std::string | GetChannelName () const |
+std::string | GetName () const |
std::string | GetChannelPrefix () const |
+std::string | GetPrefix () const |
std::string | GetChannelIndex () const |
+std::string | GetIndex () const |
std::string | GetType () const |
std::string | GetMethod () const |
std::string | GetAddress () const |
std::string | GetTransportName () 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) |
+void | UpdateName (const std::string &name) |
bool | IsValid () const |
bool | ValidateChannel () |
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) |
+int | SendAsync (FairMQMessagePtr &msg) __attribute__((deprecated("For non-blocking Send |
+return fSocket | Send (msg, 0) |
+int | ReceiveAsync (FairMQMessagePtr &msg) __attribute__((deprecated("For non-blocking Receive |
+return fSocket | Receive (msg, 0) |
int64_t | Send (std::vector< FairMQMessagePtr > &msgVec, int sndTimeoutInMs=-1) |
int64_t | Receive (std::vector< FairMQMessagePtr > &msgVec, int rcvTimeoutInMs=-1) |
+int64_t | SendAsync (std::vector< FairMQMessagePtr > &msgVec) __attribute__((deprecated("For non-blocking Send |
+return fSocket | Send (msgVec, 0) |
+int64_t | ReceiveAsync (std::vector< FairMQMessagePtr > &msgVec) __attribute__((deprecated("For non-blocking Receive |
+return fSocket | Receive (msgVec, 0) |
int64_t | Send (FairMQParts &parts, int sndTimeoutInMs=-1) |
int64_t | Receive (FairMQParts &parts, int rcvTimeoutInMs=-1) |
+int64_t | SendAsync (FairMQParts &parts) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts) __attribute__((deprecated("For non-blocking Receive |
+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) |
+Public Attributes | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(msgVec |
+int64_t use timeout version with timeout | timeout |
+Friends | |
+class | FairMQDevice |
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 ("default", "zeromq", "nanomsg" or "shmem")
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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQDevice, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQChannel (defined in FairMQDevice) | FairMQDevice | friend |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() | FairMQDevice | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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() | FairMQDevice | protectedvirtual |
PAUSE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() | FairMQDevice | protectedvirtual |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (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 |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
+Static Public Member Functions | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
+Public Attributes | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | 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 | 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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
+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. | |
+Friends | |
+class | FairMQChannel |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
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") |
void FairMQDevice::SortChannel | +( | +const std::string & | +name, | +
+ | + | const bool | +reindex = true |
+
+ | ) | ++ |
Sorts a channel by address, with optional reindexing of the sorted values
name | Channel name |
reindex | Should reindexing be done |
+
|
+ +static | +
Implements the sort algorithm used in SortChannel()
lhs | Right hand side value for comparison |
rhs | Left hand side value for comparison |
+
|
+ +inline | +
Wait for the supplied amount of time or for interruption. If interrupted, returns false, otherwise true.
duration | wait duration |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQMerger, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQMerger() (defined in FairMQMerger) | FairMQMerger | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() override | FairMQMerger | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Pause() | FairMQDevice | protectedvirtual |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() override | FairMQMerger | protectedvirtual |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (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 |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQMerger() (defined in FairMQMerger) | FairMQMerger | virtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | 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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
+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. | |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
![]() | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
![]() | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQMessageSHM, including all inherited members.
+Copy(const FairMQMessage &msg) override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
FairMQMessage()=default (defined in FairMQMessage) | FairMQMessage | |
FairMQMessage(FairMQTransportFactory *factory) (defined in FairMQMessage) | FairMQMessage | inline |
FairMQMessageSHM(fair::mq::shmem::Manager &manager, FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageSHM) | FairMQMessageSHM | |
FairMQMessageSHM(fair::mq::shmem::Manager &manager, const size_t size, FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageSHM) | FairMQMessageSHM | |
FairMQMessageSHM(fair::mq::shmem::Manager &manager, void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageSHM) | FairMQMessageSHM | |
FairMQMessageSHM(fair::mq::shmem::Manager &manager, FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *factory=nullptr) (defined in FairMQMessageSHM) | FairMQMessageSHM | |
FairMQMessageSHM(const FairMQMessageSHM &)=delete (defined in FairMQMessageSHM) | FairMQMessageSHM | |
FairMQSocketSHM (defined in FairMQMessageSHM) | FairMQMessageSHM | friend |
GetData() const override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
GetSize() const override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
GetTransport() (defined in FairMQMessage) | FairMQMessage | inline |
GetType() const override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
operator=(const FairMQMessageSHM &)=delete (defined in FairMQMessageSHM) | FairMQMessageSHM | |
Rebuild() override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
Rebuild(const size_t size) override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
Rebuild(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
SetUsedSize(const size_t size) override (defined in FairMQMessageSHM) | FairMQMessageSHM | virtual |
~FairMQMessage() (defined in FairMQMessage) | FairMQMessage | inlinevirtual |
~FairMQMessageSHM() override (defined in FairMQMessageSHM) | FairMQMessageSHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQMessageSHM (fair::mq::shmem::Manager &manager, FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageSHM (fair::mq::shmem::Manager &manager, const size_t size, FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageSHM (fair::mq::shmem::Manager &manager, void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageSHM (fair::mq::shmem::Manager &manager, FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0, FairMQTransportFactory *factory=nullptr) |
+ | FairMQMessageSHM (const FairMQMessageSHM &)=delete |
+FairMQMessageSHM | operator= (const FairMQMessageSHM &)=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 | FairMQSocketSHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQMultiplier, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQMultiplier() (defined in FairMQMultiplier) | FairMQMultiplier | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
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 FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() | FairMQMultiplier | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Pause() | FairMQDevice | protectedvirtual |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() | FairMQDevice | protectedvirtual |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (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 |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQMultiplier() (defined in FairMQMultiplier) | FairMQMultiplier | virtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | 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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
+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. | |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
![]() | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
![]() | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 |
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 | |
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.3.9
+
+ C++ Message Passing 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. | |
+ | ~FairMQParts () |
Default destructor. | |
void | AddPart (FairMQMessage *msg) |
void | AddPart (std::unique_ptr< FairMQMessage > &&msg) |
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 lvalue ref (move not required when passing argument) 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQPollerSHM, including all inherited members.
+CheckInput(const int index) override (defined in FairMQPollerSHM) | FairMQPollerSHM | virtual |
CheckInput(const std::string &channelKey, const int index) override (defined in FairMQPollerSHM) | FairMQPollerSHM | virtual |
CheckOutput(const int index) override (defined in FairMQPollerSHM) | FairMQPollerSHM | virtual |
CheckOutput(const std::string &channelKey, const int index) override (defined in FairMQPollerSHM) | FairMQPollerSHM | virtual |
FairMQChannel (defined in FairMQPollerSHM) | FairMQPollerSHM | friend |
FairMQPollerSHM(const std::vector< FairMQChannel > &channels) (defined in FairMQPollerSHM) | FairMQPollerSHM | |
FairMQPollerSHM(const std::vector< FairMQChannel * > &channels) (defined in FairMQPollerSHM) | FairMQPollerSHM | |
FairMQPollerSHM(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) (defined in FairMQPollerSHM) | FairMQPollerSHM | |
FairMQPollerSHM(const FairMQPollerSHM &)=delete (defined in FairMQPollerSHM) | FairMQPollerSHM | |
FairMQTransportFactorySHM (defined in FairMQPollerSHM) | FairMQPollerSHM | friend |
operator=(const FairMQPollerSHM &)=delete (defined in FairMQPollerSHM) | FairMQPollerSHM | |
Poll(const int timeout) override (defined in FairMQPollerSHM) | FairMQPollerSHM | virtual |
SetItemEvents(zmq_pollitem_t &item, const int type) (defined in FairMQPollerSHM) | FairMQPollerSHM | |
~FairMQPoller() (defined in FairMQPoller) | FairMQPoller | inlinevirtual |
~FairMQPollerSHM() override (defined in FairMQPollerSHM) | FairMQPollerSHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQPollerSHM (const std::vector< FairMQChannel > &channels) |
+ | FairMQPollerSHM (const std::vector< FairMQChannel * > &channels) |
+ | FairMQPollerSHM (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) |
+ | FairMQPollerSHM (const FairMQPollerSHM &)=delete |
+FairMQPollerSHM | operator= (const FairMQPollerSHM &)=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 | FairMQTransportFactorySHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQProgOptions, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQProgOptions) | FairMQProgOptions | inline |
AddToCmdLineOptions(const boost::program_options::options_description optDesc, bool visible=true) | FairMQProgOptions | |
ConvertTo(const std::string &strValue) (defined in FairMQProgOptions) | FairMQProgOptions | inline |
Count(const std::string &key) const (defined in FairMQProgOptions) | FairMQProgOptions | |
FairMQProgOptions() (defined in FairMQProgOptions) | FairMQProgOptions | |
GetChannelInfo() const (defined in FairMQProgOptions) | FairMQProgOptions | |
GetCmdLineOptions() (defined in FairMQProgOptions) | FairMQProgOptions | |
GetFairMQMap() const (defined in FairMQProgOptions) | FairMQProgOptions | |
GetPropertyKeys() const (defined in FairMQProgOptions) | FairMQProgOptions | |
GetStringValue(const std::string &key) (defined in FairMQProgOptions) | FairMQProgOptions | |
GetValue(const std::string &key) const (defined in FairMQProgOptions) | FairMQProgOptions | inline |
GetVarMap() const (defined in FairMQProgOptions) | FairMQProgOptions | inline |
ParseAll(const std::vector< std::string > &cmdLineArgs, bool allowUnregistered) (defined in FairMQProgOptions) | FairMQProgOptions | |
ParseAll(const int argc, char const *const *argv, bool allowUnregistered=true) (defined in FairMQProgOptions) | FairMQProgOptions | |
PrintOptions() (defined in FairMQProgOptions) | FairMQProgOptions | |
PrintOptionsRaw() (defined in FairMQProgOptions) | FairMQProgOptions | |
SetValue(const std::string &key, T val) (defined in FairMQProgOptions) | FairMQProgOptions | inline |
Subscribe(const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, T)> func) (defined in FairMQProgOptions) | FairMQProgOptions | inline |
SubscribeAsString(const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, std::string)> func) (defined in FairMQProgOptions) | FairMQProgOptions | inline |
Unsubscribe(const std::string &subscriber) (defined in FairMQProgOptions) | FairMQProgOptions | inline |
UnsubscribeAsString(const std::string &subscriber) (defined in FairMQProgOptions) | FairMQProgOptions | inline |
~FairMQProgOptions() (defined in FairMQProgOptions) | FairMQProgOptions | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+int | ParseAll (const std::vector< std::string > &cmdLineArgs, bool allowUnregistered) |
+int | ParseAll (const int argc, char const *const *argv, bool allowUnregistered=true) |
+FairMQChannelMap | GetFairMQMap () const |
+std::unordered_map< std::string, int > | GetChannelInfo () const |
+template<typename T > | |
int | SetValue (const std::string &key, T val) |
+template<typename T > | |
void | Subscribe (const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, T)> func) |
+template<typename T > | |
void | Unsubscribe (const std::string &subscriber) |
+void | SubscribeAsString (const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, std::string)> func) |
+void | UnsubscribeAsString (const std::string &subscriber) |
+std::vector< std::string > | GetPropertyKeys () const |
+template<typename T > | |
T | GetValue (const std::string &key) const |
+std::string | GetStringValue (const std::string &key) |
+int | Count (const std::string &key) const |
+template<typename T > | |
T | ConvertTo (const std::string &strValue) |
+int | AddToCmdLineOptions (const boost::program_options::options_description optDesc, bool visible=true) |
Add option descriptions. | |
+boost::program_options::options_description & | GetCmdLineOptions () |
+const boost::program_options::variables_map & | GetVarMap () const |
+int | PrintOptions () |
+int | PrintOptionsRaw () |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQProxy, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQProxy() (defined in FairMQProxy) | FairMQProxy | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() | FairMQProxy | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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() | FairMQDevice | protectedvirtual |
PAUSE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() | FairMQProxy | protectedvirtual |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (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 |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQProxy() (defined in FairMQProxy) | FairMQProxy | virtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | 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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
+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. | |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
![]() | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
![]() | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQSink, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQSink() (defined in FairMQSink) | FairMQSink | inline |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() | FairMQSink | inlineprotectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Pause() | FairMQDevice | protectedvirtual |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() | FairMQSink | inlineprotectedvirtual |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (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 |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQSink() (defined in FairMQSink) | FairMQSink | inlinevirtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | 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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
+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. | |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
![]() | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
![]() | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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()=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.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQSocket (FairMQTransportFactory *fac) |
+virtual std::string | GetId ()=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.3.9
+
+ C++ Message Passing 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() override (defined in FairMQSocketNN) | FairMQSocketNN | virtual |
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.3.9
+
+ C++ Message Passing 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 () 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQSocketSHM, including all inherited members.
+Bind(const std::string &address) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
Close() override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
Connect(const std::string &address) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocket(FairMQTransportFactory *fac) (defined in FairMQSocket) | FairMQSocket | inline |
FairMQSocketSHM(fair::mq::shmem::Manager &manager, const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr, FairMQTransportFactory *fac=nullptr) (defined in FairMQSocketSHM) | FairMQSocketSHM | |
FairMQSocketSHM(const FairMQSocketSHM &)=delete (defined in FairMQSocketSHM) | FairMQSocketSHM | |
GetBytesRx() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetBytesTx() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetConstant(const std::string &constant) (defined in FairMQSocketSHM) | FairMQSocketSHM | static |
GetId() override (defined in FairMQSocketSHM) | FairMQSocketSHM | inlinevirtual |
GetLinger() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetMessagesRx() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetMessagesTx() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetOption(const std::string &option, void *value, size_t *valueSize) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetRcvBufSize() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetRcvKernelSize() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetSndBufSize() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetSndKernelSize() const override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
GetSocket() const (defined in FairMQSocketSHM) | FairMQSocketSHM | |
GetTransport() (defined in FairMQSocket) | FairMQSocket | inline |
Interrupt() (defined in FairMQSocketSHM) | FairMQSocketSHM | static |
operator=(const FairMQSocketSHM &)=delete (defined in FairMQSocketSHM) | FairMQSocketSHM | |
Receive(FairMQMessagePtr &msg, const int timeout=-1) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
Receive(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
Resume() (defined in FairMQSocketSHM) | FairMQSocketSHM | static |
Send(FairMQMessagePtr &msg, const int timeout=-1) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
Send(std::vector< std::unique_ptr< FairMQMessage >> &msgVec, const int timeout=-1) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
SetLinger(const int value) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
SetOption(const std::string &option, const void *value, size_t valueSize) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
SetRcvBufSize(const int value) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
SetRcvKernelSize(const int value) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
SetSndBufSize(const int value) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
SetSndKernelSize(const int value) override (defined in FairMQSocketSHM) | FairMQSocketSHM | virtual |
SetTransport(FairMQTransportFactory *transport) (defined in FairMQSocket) | FairMQSocket | inline |
~FairMQSocket() (defined in FairMQSocket) | FairMQSocket | inlinevirtual |
~FairMQSocketSHM() override (defined in FairMQSocketSHM) | FairMQSocketSHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQSocketSHM (fair::mq::shmem::Manager &manager, const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr, FairMQTransportFactory *fac=nullptr) |
+ | FairMQSocketSHM (const FairMQSocketSHM &)=delete |
+FairMQSocketSHM | operator= (const FairMQSocketSHM &)=delete |
+std::string | GetId () 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.3.9
+
+ C++ Message Passing 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() override (defined in FairMQSocketZMQ) | FairMQSocketZMQ | virtual |
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.3.9
+
+ C++ Message Passing 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 () 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQSplitter, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQSplitter() (defined in FairMQSplitter) | FairMQSplitter | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
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 FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() | FairMQSplitter | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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() | FairMQDevice | protectedvirtual |
PAUSE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() | FairMQDevice | protectedvirtual |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (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 |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQSplitter() (defined in FairMQSplitter) | FairMQSplitter | virtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | 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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
+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. | |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
![]() | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
![]() | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | fConfig |
Pointer to config (internal or external) | |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQStateMachine, including all inherited members.
+CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
Exit() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTaskWrapper() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
InitWrapper() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PAUSE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PauseWrapper() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTaskWrapper() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetWrapper() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RunWrapper() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
Unblock() (defined in FairMQStateMachine) | FairMQStateMachine | inlinevirtual |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static std::string | GetStateName (const State) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 (defined in FairMQTransportFactory) | 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 FairMQProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr) const =0 (defined in FairMQTransportFactory) | 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 |
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 |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 |
+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 =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 FairMQProgOptions *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 FairMQTransportFactoryZMQ, FairMQTransportFactorySHM, and FairMQTransportFactoryNN.
+ +
+
|
+ +pure virtual | +
Create new FairMQMessage of specified size.
+size | message size |
Implemented in FairMQTransportFactoryZMQ, FairMQTransportFactorySHM, 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 FairMQTransportFactoryZMQ, FairMQTransportFactorySHM, and FairMQTransportFactoryNN.
+ +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 (defined in FairMQTransportFactoryNN) | 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 FairMQProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback) const override (defined in FairMQTransportFactoryNN) | 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 FairMQProgOptions *config=nullptr) (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN | |
GetId() const -> const std::string (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
GetMemoryResource() | FairMQTransportFactory | inline |
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 |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
~FairMQTransportFactoryNN() override (defined in FairMQTransportFactoryNN) | FairMQTransportFactoryNN |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQTransportFactoryNN (const std::string &id="", const FairMQProgOptions *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 |
+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 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 FairMQProgOptions *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.
+ +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQTransportFactorySHM, including all inherited members.
+CreateMessage() override | FairMQTransportFactorySHM | virtual |
CreateMessage(const size_t size) override | FairMQTransportFactorySHM | virtual |
CreateMessage(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override | FairMQTransportFactorySHM | virtual |
CreateMessage(FairMQUnmanagedRegionPtr ®ion, void *data, const size_t size, void *hint=0) override (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | virtual |
CreatePoller(const std::vector< FairMQChannel > &channels) const override | FairMQTransportFactorySHM | virtual |
CreatePoller(const std::vector< FairMQChannel * > &channels) const override | FairMQTransportFactorySHM | virtual |
CreatePoller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override | FairMQTransportFactorySHM | virtual |
CreateSocket(const std::string &type, const std::string &name) override | FairMQTransportFactorySHM | virtual |
CreateTransportFactory(const std::string &type, const std::string &id="", const FairMQProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr) const override (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | virtual |
FairMQNoCleanup(void *, void *) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQSimpleMsgCleanup(void *, void *obj) (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinestatic |
FairMQTransportFactory(const std::string &id) | FairMQTransportFactory | |
FairMQTransportFactorySHM(const std::string &id="", const FairMQProgOptions *config=nullptr) (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | |
FairMQTransportFactorySHM(const FairMQTransportFactorySHM &)=delete (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | |
GetId() const -> const std::string (defined in FairMQTransportFactory) | FairMQTransportFactory | inline |
GetMemoryResource() | FairMQTransportFactory | inline |
GetType() const override | FairMQTransportFactorySHM | virtual |
Interrupt() override (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | 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 FairMQTransportFactorySHM &)=delete (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | |
Reset() override (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | inlinevirtual |
Resume() override (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM | inlinevirtual |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
~FairMQTransportFactorySHM() override (defined in FairMQTransportFactorySHM) | FairMQTransportFactorySHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQTransportFactorySHM (const std::string &id="", const FairMQProgOptions *config=nullptr) |
+ | FairMQTransportFactorySHM (const FairMQTransportFactorySHM &)=delete |
+FairMQTransportFactorySHM | operator= (const FairMQTransportFactorySHM &)=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 |
+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=nullptr) const 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 FairMQProgOptions *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.
+ +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 (defined in FairMQTransportFactoryZMQ) | 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 FairMQProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback) const override (defined in FairMQTransportFactoryZMQ) | 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 FairMQProgOptions *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 |
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 |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
~FairMQTransportFactoryZMQ() override (defined in FairMQTransportFactoryZMQ) | FairMQTransportFactoryZMQ |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
#include <FairMQTransportFactoryZMQ.h>
+Public Member Functions | |
+ | FairMQTransportFactoryZMQ (const std::string &id="", const FairMQProgOptions *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 |
+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 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 FairMQProgOptions *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.
+ +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+virtual void * | GetData () const =0 |
+virtual size_t | GetSize () const =0 |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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) (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.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQUnmanagedRegionNN (const size_t size, FairMQRegionCallback callback) |
+ | 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for FairMQUnmanagedRegionSHM, including all inherited members.
+FairMQMessageSHM (defined in FairMQUnmanagedRegionSHM) | FairMQUnmanagedRegionSHM | friend |
FairMQSocketSHM (defined in FairMQUnmanagedRegionSHM) | FairMQUnmanagedRegionSHM | friend |
FairMQUnmanagedRegionSHM(fair::mq::shmem::Manager &manager, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQUnmanagedRegionSHM) | FairMQUnmanagedRegionSHM | |
GetData() const override (defined in FairMQUnmanagedRegionSHM) | FairMQUnmanagedRegionSHM | virtual |
GetSize() const override (defined in FairMQUnmanagedRegionSHM) | FairMQUnmanagedRegionSHM | virtual |
~FairMQUnmanagedRegion() (defined in FairMQUnmanagedRegion) | FairMQUnmanagedRegion | inlinevirtual |
~FairMQUnmanagedRegionSHM() override (defined in FairMQUnmanagedRegionSHM) | FairMQUnmanagedRegionSHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQUnmanagedRegionSHM (fair::mq::shmem::Manager &manager, const size_t size, FairMQRegionCallback callback=nullptr) |
+void * | GetData () const override |
+size_t | GetSize () const override |
+Friends | |
+class | FairMQSocketSHM |
+class | FairMQMessageSHM |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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) (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.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | FairMQUnmanagedRegionZMQ (const size_t size, FairMQRegionCallback callback) |
+ | 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for MyDevice, including all inherited members.
+AddChannel(const std::string &channelName, const FairMQChannel &channel) (defined in FairMQDevice) | FairMQDevice | inline |
AddTransport(const fair::mq::Transport transport) | FairMQDevice | |
CallStateChangeCallbacks(const State state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CatchSignals() | FairMQDevice | |
ChangeState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
ChangeState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
channelA (defined in FairMQDevice) | FairMQDevice | |
channelA (defined in FairMQDevice) | FairMQDevice | |
CheckCurrentState(int state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
CheckCurrentState(const std::string &state) const (defined in FairMQStateMachine) | FairMQStateMachine | |
ConditionalRun() | FairMQDevice | protectedvirtual |
Deserialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
END enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Error enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ERROR_FOUND enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Event enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
EXITING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
FairMQDevice() | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config) | FairMQDevice | |
FairMQDevice(const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(FairMQProgOptions &config, const fair::mq::tools::Version version) | FairMQDevice | |
FairMQDevice(const FairMQDevice &)=delete | FairMQDevice | |
FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
GetCurrentState() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetCurrentStateName() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetDefaultTransport() const (defined in FairMQDevice) | FairMQDevice | inline |
GetId() (defined in FairMQDevice) | FairMQDevice | inline |
GetInitializationTimeoutInS() const (defined in FairMQDevice) | FairMQDevice | inline |
GetInterfaceVersion() const (defined in FairMQStateMachine) | FairMQStateMachine | |
GetNetworkInterface() const (defined in FairMQDevice) | FairMQDevice | inline |
GetNumIoThreads() const (defined in FairMQDevice) | FairMQDevice | inline |
GetRate() (defined in MyDevice) | MyDevice | inline |
GetRawCmdLineArgs() const (defined in FairMQDevice) | FairMQDevice | inline |
GetStateName(const State) (defined in FairMQStateMachine) | FairMQStateMachine | static |
GetTransportName() const | FairMQDevice | inline |
GetVersion() const (defined in FairMQDevice) | FairMQDevice | inline |
IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Init() | FairMQDevice | protectedvirtual |
INIT_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INIT_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
INITIALIZING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
InitTask() | FairMQDevice | protectedvirtual |
internal_DEVICE_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_IDLE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
internal_READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
LogSocketRates() | FairMQDevice | virtual |
MyDevice() (defined in MyDevice) | MyDevice | inline |
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) (defined in FairMQDevice) | FairMQDevice | inline |
NewUnmanagedRegionFor(const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) (defined in FairMQDevice) | FairMQDevice | inline |
of (defined in FairMQDevice) | FairMQDevice | |
of (defined in FairMQDevice) | FairMQDevice | |
OK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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() | FairMQDevice | protectedvirtual |
PAUSE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PAUSED enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
PostRun() | FairMQDevice | protectedvirtual |
PreRun() | FairMQDevice | protectedvirtual |
Print() (defined in MyDevice) | MyDevice | inline |
PrintRegisteredChannels() (defined in FairMQDevice) | FairMQDevice | inline |
ProcessWork() (defined in FairMQStateMachine) | FairMQStateMachine | |
READY enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
ReceiveAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
ReceiveAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive (defined in FairMQDevice) | FairMQDevice | |
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() | FairMQDevice | protectedvirtual |
RESET_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESET_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
ResetTask() | FairMQDevice | protectedvirtual |
RESETTING_DEVICE enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RESETTING_TASK enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
RUN enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
Run() | FairMQDevice | protectedvirtual |
RUNNING enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
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 |
SendAsync(FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
SendAsync(FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send (defined in FairMQDevice) | FairMQDevice | |
Serialize(FairMQMessage &msg, DataType &&data, Args &&... args) const (defined in FairMQDevice) | FairMQDevice | inline |
SetConfig(FairMQProgOptions &config) | FairMQDevice | |
SetDefaultTransport(const std::string &name) (defined in FairMQDevice) | FairMQDevice | inline |
SetId(const std::string &id) (defined in FairMQDevice) | FairMQDevice | inline |
SetInitializationTimeoutInS(int initializationTimeoutInS) (defined in FairMQDevice) | FairMQDevice | inline |
SetNetworkInterface(const std::string &networkInterface) (defined in FairMQDevice) | FairMQDevice | inline |
SetNumIoThreads(int numIoThreads) (defined in FairMQDevice) | FairMQDevice | inline |
SetRate(double r) (defined in MyDevice) | MyDevice | inline |
SetRawCmdLineArgs(const std::vector< std::string > &args) (defined in FairMQDevice) | FairMQDevice | inline |
SetTransport(const std::string &transport) | FairMQDevice | inline |
SortChannel(const std::string &name, const bool reindex=true) | FairMQDevice | |
SortSocketsByAddress(const FairMQChannel &lhs, const FairMQChannel &rhs) | FairMQDevice | static |
State enum name (defined in FairMQStateMachine) | FairMQStateMachine | |
STOP enum value (defined in FairMQStateMachine) | FairMQStateMachine | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
subchannelIndex (defined in FairMQDevice) | FairMQDevice | |
SubscribeToStateChange(const std::string &key, std::function< void(const State)> callback) (defined in FairMQStateMachine) | FairMQStateMachine | |
timeout (defined in FairMQDevice) | FairMQDevice | |
timeout (defined in FairMQDevice) | FairMQDevice | |
Transport() const -> FairMQTransportFactory * | FairMQDevice | inline |
UnsubscribeFromStateChange(const std::string &key) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitFor(std::chrono::duration< Rep, Period > const &duration) | FairMQDevice | inline |
WaitForEndOfState(int event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfState(const std::string &event) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(int event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForEndOfStateForMs(const std::string &event, int durationInMs) (defined in FairMQStateMachine) | FairMQStateMachine | |
WaitForInitialValidation() __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) | FairMQDevice | inline |
~FairMQDevice() | FairMQDevice | virtual |
~FairMQStateMachine() (defined in FairMQStateMachine) | FairMQStateMachine | virtual |
~MyDevice() (defined in MyDevice) | MyDevice | inlinevirtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+void | SetRate (double r) |
+double | GetRate () |
+void | Print () |
![]() | |
+ | FairMQDevice () |
Default constructor. | |
+ | FairMQDevice (FairMQProgOptions &config) |
Constructor with external FairMQProgOptions. | |
+ | FairMQDevice (const fair::mq::tools::Version version) |
Constructor that sets the version. | |
+ | FairMQDevice (FairMQProgOptions &config, const fair::mq::tools::Version version) |
Constructor that sets the version and external FairMQProgOptions. | |
+ | FairMQDevice (const FairMQDevice &)=delete |
Copy constructor (disabled) | |
+FairMQDevice | operator= (const FairMQDevice &)=delete |
Assignment operator (disabled) | |
+virtual | ~FairMQDevice () |
Default destructor. | |
+void | CatchSignals () |
Catches interrupt signals (SIGINT, SIGTERM) | |
+virtual void | LogSocketRates () |
Outputs the socket transfer rates. | |
void | SortChannel (const std::string &name, const bool reindex=true) |
+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) |
+int | SendAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int | ReceiveAsync (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
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) |
+int64_t | SendAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Send |
+int64_t | ReceiveAsync (FairMQParts &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking Receive |
+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) |
+FairMQUnmanagedRegionPtr | NewUnmanagedRegionFor (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr) |
+template<typename ... Ts> | |
FairMQPollerPtr | NewPoller (const Ts &... inputs) |
+FairMQPollerPtr | NewPoller (const std::vector< FairMQChannel * > &channels) |
+void | WaitForInitialValidation () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values."))) |
Waits for the first initialization run to finish. | |
std::shared_ptr< FairMQTransportFactory > | AddTransport (const fair::mq::Transport transport) |
+void | SetConfig (FairMQProgOptions &config) |
Assigns config to the device. | |
+FairMQProgOptions * | 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 | SetInitializationTimeoutInS (int initializationTimeoutInS) |
+int | GetInitializationTimeoutInS () 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<class Rep , class Period > | |
bool | WaitFor (std::chrono::duration< Rep, Period > const &duration) |
+void | AddChannel (const std::string &channelName, const FairMQChannel &channel) |
![]() | |
+int | GetInterfaceVersion () const |
+bool | ChangeState (int event) |
+bool | ChangeState (const std::string &event) |
+void | WaitForEndOfState (int event) |
+void | WaitForEndOfState (const std::string &event) |
+bool | WaitForEndOfStateForMs (int event, int durationInMs) |
+bool | WaitForEndOfStateForMs (const std::string &event, int durationInMs) |
+void | SubscribeToStateChange (const std::string &key, std::function< void(const State)> callback) |
+void | UnsubscribeFromStateChange (const std::string &key) |
+void | CallStateChangeCallbacks (const State state) const |
+std::string | GetCurrentStateName () const |
+int | GetCurrentState () const |
+bool | CheckCurrentState (int state) const |
+bool | CheckCurrentState (const std::string &state) const |
+void | ProcessWork () |
+Additional Inherited Members | |
![]() | |
enum | Event { + INIT_DEVICE, +internal_DEVICE_READY, +INIT_TASK, +internal_READY, + + RUN, +PAUSE, +STOP, +RESET_TASK, + + RESET_DEVICE, +internal_IDLE, +END, +ERROR_FOUND + + } |
enum | State { + OK, +Error, +IDLE, +INITIALIZING_DEVICE, + + DEVICE_READY, +INITIALIZING_TASK, +READY, +RUNNING, + + PAUSED, +RESETTING_TASK, +RESETTING_DEVICE, +EXITING + + } |
![]() | |
static bool | SortSocketsByAddress (const FairMQChannel &lhs, const FairMQChannel &rhs) |
![]() | |
+static std::string | GetStateName (const State) |
![]() | |
+int use timeout version with timeout | of: Send(msg |
+int use timeout version with timeout | channelA |
+int use timeout version with timeout | subchannelIndex |
+int use timeout version with timeout | timeout |
+int64_t use timeout version with timeout | of: Send(parts |
+int64_t use timeout version with timeout | channelA |
+int64_t use timeout version with timeout | subchannelIndex |
+int64_t use timeout version with timeout | timeout |
+std::unordered_map< std::string, std::vector< FairMQChannel > > | fChannels |
Device channels. | |
+std::unique_ptr< FairMQProgOptions > | fInternalConfig |
Internal program options configuration. | |
+FairMQProgOptions * | fConfig |
Pointer to config (internal or external) | |
![]() | |
+virtual void | Init () |
Additional user initialization (can be overloaded in child classes). Prefer to use InitTask(). | |
+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 () |
Handles the PAUSE state. | |
+virtual void | ResetTask () |
Resets the user task (to be overloaded in child classes) | |
+virtual void | Reset () |
Resets the device (can be overloaded in child classes) | |
![]() | |
+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. | |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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 | |
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 |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 |
+template<typename H > | |
auto | AddHook (std::function< void(DeviceRunner &)> hook) -> void |
+template<typename H > | |
auto | RemoveHook () -> void |
+Public Attributes | |
+std::vector< std::string > | fRawCmdLineArgs |
+FairMQProgOptions | 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::Plugin, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> void (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 |
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 |
GetProperty(const std::string &key) const -> T (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const -> std::string (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(const std::string name, const Version version, const std::string maintainer, const 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 |
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 |
Version typedef (defined in fair::mq::Plugin) | fair::mq::Plugin | |
~Plugin() (defined in fair::mq::Plugin) | fair::mq::Plugin | virtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 (const std::string name, const Version version, const std::string maintainer, const 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) -> void |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+template<typename T > | |
auto | GetProperty (const std::string &key) const -> T |
+auto | GetPropertyAsString (const std::string &key) const -> std::string |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::PluginServices, including all inherited members.
+ChangeDeviceState(const std::string &controller, const DeviceStateTransition next) -> void | fair::mq::PluginServices | |
CycleLogConsoleSeverityDown() -> void (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
CycleLogConsoleSeverityUp() -> void (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
CycleLogVerbosityDown() -> void (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
CycleLogVerbosityUp() -> void (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
DeviceState enum name | fair::mq::PluginServices | |
DeviceStateTransition enum name (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
fkDeviceStateMap (defined in fair::mq::PluginServices) | fair::mq::PluginServices | static |
fkDeviceStateStrMap (defined in fair::mq::PluginServices) | fair::mq::PluginServices | static |
fkDeviceStateTransitionMap (defined in fair::mq::PluginServices) | fair::mq::PluginServices | static |
fkDeviceStateTransitionStrMap (defined in fair::mq::PluginServices) | fair::mq::PluginServices | static |
fkStrDeviceStateMap (defined in fair::mq::PluginServices) | fair::mq::PluginServices | static |
fkStrDeviceStateTransitionMap (defined in fair::mq::PluginServices) | fair::mq::PluginServices | static |
GetChannelInfo() const -> std::unordered_map< std::string, int > (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
GetCurrentDeviceState() const -> DeviceState | fair::mq::PluginServices | inline |
GetDeviceController() const -> boost::optional< std::string > | fair::mq::PluginServices | |
GetProperty(const std::string &key) const -> T | fair::mq::PluginServices | inline |
GetPropertyAsString(const std::string &key) const -> std::string | fair::mq::PluginServices | inline |
GetPropertyKeys() const -> std::vector< std::string > | fair::mq::PluginServices | inline |
operator<< (defined in fair::mq::PluginServices) | fair::mq::PluginServices | friend |
operator<< (defined in fair::mq::PluginServices) | fair::mq::PluginServices | friend |
operator=(const PluginServices &)=delete (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
PluginServices()=delete (defined in fair::mq::PluginServices) | fair::mq::PluginServices | |
PluginServices(FairMQProgOptions &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 (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
ReleaseDeviceControl(const std::string &controller) -> void | fair::mq::PluginServices | |
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 |
WaitForReleaseDeviceControl() -> void | fair::mq::PluginServices | |
~PluginServices() (defined in fair::mq::PluginServices) | fair::mq::PluginServices | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
Facilitates communication between devices and plugins. + More...
+ +#include <fairmq/PluginServices.h>
+Classes | |
struct | DeviceControlError |
struct | InvalidStateError |
struct | PropertyNotFoundError |
+Public Types | |
enum | DeviceState : int { + Ok, +Error, +Idle, +InitializingDevice, + + DeviceReady, +InitializingTask, +Ready, +Running, + + Paused, +ResettingTask, +ResettingDevice, +Exiting + + } |
See https://github.com/FairRootGroup/FairRoot/blob/dev/fairmq/docs/Device.md#13-state-machine. | |
enum | DeviceStateTransition : int { + InitDevice, +InitTask, +Run, +Pause, + + Resume, +Stop, +ResetTask, +ResetDevice, + + End, +ErrorFound + + } |
+Public Member Functions | |
+ | PluginServices (FairMQProgOptions &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) -> void |
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 |
template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
Set config property. More... | |
template<typename T > | |
auto | GetProperty (const std::string &key) const -> T |
Read config property. More... | |
auto | GetPropertyAsString (const std::string &key) const -> std::string |
Read config property as string. More... | |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
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 |
+auto | CycleLogConsoleSeverityDown () -> void |
+auto | CycleLogVerbosityUp () -> void |
+auto | CycleLogVerbosityDown () -> void |
+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... | |
+Static Public Attributes | |
static const std::unordered_map< std::string, DeviceState > | fkDeviceStateStrMap |
static const std::unordered_map< DeviceState, std::string, tools::HashEnum< DeviceState > > | fkStrDeviceStateMap |
static const std::unordered_map< std::string, DeviceStateTransition > | fkDeviceStateTransitionStrMap |
static const std::unordered_map< DeviceStateTransition, std::string, tools::HashEnum< DeviceStateTransition > > | fkStrDeviceStateTransitionMap |
static const std::unordered_map< FairMQDevice::State, DeviceState, tools::HashEnum< FairMQDevice::State > > | fkDeviceStateMap |
static const std::unordered_map< DeviceStateTransition, FairMQDevice::Event, tools::HashEnum< DeviceStateTransition > > | fkDeviceStateTransitionMap |
+Friends | |
+auto | operator<< (std::ostream &os, const DeviceState &state) -> std::ostream & |
+auto | operator<< (std::ostream &os, const DeviceStateTransition &transition) -> std::ostream & |
Facilitates communication between devices and plugins.
+auto PluginServices::ChangeDeviceState | +( | +const std::string & | +controller, | +
+ | + | const DeviceStateTransition | +next | +
+ | ) | +-> void | +
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 | +
+
|
+ +inline | +
Read config property.
+key |
TODO Currently, if a non-existing key is requested and a default constructed object is returned. This behaviour will be changed in the future to throw an exception in that case to provide a proper sentinel.
+ +
+
|
+ +inline | +
Read config property as string.
+key |
If a type is not supported, the user can provide support by overloading the ostream operator for this type
+ +
+
|
+ +inline | +
Discover the list of property keys.
+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 config property.
+key | |
val |
fair::mq::PluginServices::InvalidStateError | if method is called in unsupported device states |
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 |
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::StateMachine, including all inherited members.
+ChangeState(StateTransition transition) -> void (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
GetCurrentErrorState() const -> State (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
GetCurrentState() const -> State (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
GetLastQueuedState() const -> State (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
NextStatePending() -> bool (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
operator<< (defined in fair::mq::StateMachine) | fair::mq::StateMachine | friend |
operator<< (defined in fair::mq::StateMachine) | fair::mq::StateMachine | friend |
Reset() -> void (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
Run() -> void (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
State enum name (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
StateMachine() (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
StateTransition enum name (defined in fair::mq::StateMachine) | fair::mq::StateMachine | |
SubscribeToStateChange(const std::string &subscriber, std::function< void(typename StateChange::KeyType newState, State lastState)> callback) -> void (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
SubscribeToStateQueued(const std::string &subscriber, std::function< void(typename StateQueued::KeyType newState, State lastState)> callback) -> void (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
ToState(const std::string &state) -> State | fair::mq::StateMachine | inlinestatic |
ToStateTransition(const std::string &transition) -> StateTransition | fair::mq::StateMachine | inlinestatic |
ToStr(State state) -> std::string | fair::mq::StateMachine | inlinestatic |
ToStr(StateTransition transition) -> std::string | fair::mq::StateMachine | inlinestatic |
UnsubscribeFromStateChange(const std::string &subscriber) -> void (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
UnsubscribeFromStateQueued(const std::string &subscriber) -> void (defined in fair::mq::StateMachine) | fair::mq::StateMachine | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
Implements the state machine for FairMQ devices. + More...
+ +#include <fairmq/StateMachine.h>
+Classes | |
struct | IllegalTransition |
struct | StateChange |
struct | StateQueued |
+Public Types | |
enum | State : int { + Ok, +Error, +Idle, +InitializingDevice, + + DeviceReady, +InitializingTask, +Ready, +Running, + + ResettingTask, +ResettingDevice, +Exiting + + } |
enum | StateTransition : int { + InitDevice, +InitTask, +Run, +Stop, + + ResetTask, +ResetDevice, +End, +ErrorFound, + + Automatic + + } |
+Public Member Functions | |
+auto | SubscribeToStateChange (const std::string &subscriber, std::function< void(typename StateChange::KeyType newState, State lastState)> callback) -> void |
+auto | UnsubscribeFromStateChange (const std::string &subscriber) -> void |
+auto | SubscribeToStateQueued (const std::string &subscriber, std::function< void(typename StateQueued::KeyType newState, State lastState)> callback) -> void |
+auto | UnsubscribeFromStateQueued (const std::string &subscriber) -> void |
+auto | GetCurrentState () const -> State |
+auto | GetCurrentErrorState () const -> State |
+auto | GetLastQueuedState () const -> State |
+auto | ChangeState (StateTransition transition) -> void |
+auto | Run () -> void |
+auto | Reset () -> void |
+auto | NextStatePending () -> bool |
+Static Public Member Functions | |
static auto | ToState (const std::string &state) -> State |
Convert string to State. More... | |
static auto | ToStateTransition (const std::string &transition) -> StateTransition |
Convert string to StateTransition. More... | |
static auto | ToStr (State state) -> std::string |
Convert State to string. More... | |
static auto | ToStr (StateTransition transition) -> std::string |
Convert StateTransition to string. More... | |
+Friends | |
+auto | operator<< (std::ostream &os, const State &state) -> std::ostream & |
+auto | operator<< (std::ostream &os, const StateTransition &transition) -> std::ostream & |
Implements the state machine for FairMQ devices.
+See https://github.com/FairRootGroup/FairRoot/blob/dev/fairmq/docs/Device.md#13-state-machine
+
+
|
+ +inlinestatic | +
Convert string to State.
+state | to convert |
std::out_of_range | if a string cannot be resolved to a State |
+
|
+ +inlinestatic | +
Convert string to StateTransition.
+transition | to convert |
std::out_of_range | if a string cannot be resolved to a StateTransition |
+
|
+ +inlinestatic | +
Convert State to string.
+state | to convert |
+
|
+ +inlinestatic | +
Convert StateTransition to string.
+transition | to convert |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::ofi::Context, including all inherited members.
+AddressVectorLookup(fi_addr_t address) -> sockaddr_in (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
Context(int numberIoThreads=2) (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 |
CreateOfiCompletionQueue(Direction dir) -> fid_cq * (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
CreateOfiEndpoint() -> fid_ep * (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
GetBoostVersion() const -> std::string (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
GetIoContext() -> boost::asio::io_service & (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | inline |
GetOfiApiVersion() const -> std::string (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
GetPbVersion() const -> std::string (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
GetZmqContext() const -> void * (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | inline |
GetZmqVersion() const -> std::string (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
InitOfi(ConnectionType type, Address address) -> void (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
InsertAddressVector(sockaddr_in address) -> fi_addr_t (defined in fair::mq::ofi::Context) | fair::mq::ofi::Context | |
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.3.9
+
+ C++ Message Passing Framework
+ |
+
Transport-wide context. + More...
+ +#include <fairmq/ofi/Context.h>
+Classes | |
struct | Address |
+Public Member Functions | |
+ | Context (int numberIoThreads=2) |
+auto | CreateOfiEndpoint () -> fid_ep * |
+auto | CreateOfiCompletionQueue (Direction dir) -> fid_cq * |
+auto | GetZmqVersion () const -> std::string |
+auto | GetOfiApiVersion () const -> std::string |
+auto | GetPbVersion () const -> std::string |
+auto | GetBoostVersion () const -> std::string |
+auto | GetZmqContext () const -> void * |
+auto | GetIoContext () -> boost::asio::io_service & |
+auto | InsertAddressVector (sockaddr_in address) -> fi_addr_t |
+auto | AddressVectorLookup (fi_addr_t address) -> sockaddr_in |
+auto | InitOfi (ConnectionType type, Address address) -> 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.3.9
+
+ C++ Message Passing 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() (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Message(const size_t size) (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Message(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) (defined in fair::mq::ofi::Message) | fair::mq::ofi::Message | |
Message(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.3.9
+
+ C++ Message Passing Framework
+ |
+
#include <fairmq/ofi/Message.h>
+Public Member Functions | |
+ | Message (const size_t size) |
+ | Message (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) |
+ | Message (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.3.9
+
+ C++ Message Passing 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 | |
CheckInput(const std::string &channelKey, const int index)=0 (defined in FairMQPoller) | FairMQPoller | pure 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 | |
CheckOutput(const std::string &channelKey, const int index)=0 (defined in FairMQPoller) | FairMQPoller | pure 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.3.9
+
+ C++ Message Passing 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 |
![]() | |
+virtual bool | CheckInput (const std::string &channelKey, const int index)=0 |
+virtual bool | CheckOutput (const std::string &channelKey, const int index)=0 |
+Friends | |
+class | FairMQChannel |
+class | TransportFactory |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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() -> std::string (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 &factory, const std::string &type, const std::string &name, const std::string &id="", FairMQTransportFactory *fac) (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
Socket(const Socket &)=delete (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
TryReceive(MessagePtr &msg) -> int override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
TryReceive(std::vector< MessagePtr > &msgVec) -> int64_t override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
TrySend(MessagePtr &msg) -> int override (defined in fair::mq::ofi::Socket) | fair::mq::ofi::Socket | |
TrySend(std::vector< MessagePtr > &msgVec) -> int64_t override (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.3.9
+
+ C++ Message Passing Framework
+ |
+
#include <fairmq/ofi/Socket.h>
+Public Member Functions | |
+ | Socket (Context &factory, const std::string &type, const std::string &name, const std::string &id="", FairMQTransportFactory *fac) |
+ | Socket (const Socket &)=delete |
+Socket | operator= (const Socket &)=delete |
+auto | GetId () -> std::string |
+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 | TrySend (MessagePtr &msg) -> int override |
+auto | TryReceive (MessagePtr &msg) -> int override |
+auto | TrySend (std::vector< MessagePtr > &msgVec) -> int64_t override |
+auto | TryReceive (std::vector< MessagePtr > &msgVec) -> 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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::ofi::TransportFactory, including all inherited members.
+CreateMessage() const -> MessagePtr override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
CreateMessage(const std::size_t size) const -> 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) const -> 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) const -> MessagePtr override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
FairMQTransportFactory::CreateMessage()=0 | FairMQTransportFactory | pure virtual |
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 |
CreateMessage(FairMQUnmanagedRegionPtr &unmanagedRegion, void *data, const size_t size, void *hint=0)=0 (defined in FairMQTransportFactory) | FairMQTransportFactory | pure virtual |
CreatePoller(const std::vector< FairMQChannel > &channels) const -> PollerPtr override | fair::mq::ofi::TransportFactory | virtual |
CreatePoller(const std::vector< const FairMQChannel * > &channels) const -> PollerPtr override (defined in fair::mq::ofi::TransportFactory) | fair::mq::ofi::TransportFactory | |
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 |
FairMQTransportFactory::CreatePoller(const std::vector< FairMQChannel * > &channels) const =0 | FairMQTransportFactory | pure 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 FairMQProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory > (defined in FairMQTransportFactory) | FairMQTransportFactory | static |
CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr) const -> UnmanagedRegionPtr override (defined in fair::mq::ofi::TransportFactory) | 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 |
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 |
TransportFactory(const std::string &id="", const FairMQProgOptions *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 | |
~FairMQTransportFactory() (defined in FairMQTransportFactory) | FairMQTransportFactory | inlinevirtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
FairMQ transport factory for the ofi transport (implemented with ZeroMQ + libfabric) + More...
+ +#include <fairmq/ofi/TransportFactory.h>
+Public Member Functions | |
+ | TransportFactory (const std::string &id="", const FairMQProgOptions *config=nullptr) |
+ | TransportFactory (const TransportFactory &)=delete |
+TransportFactory | operator= (const TransportFactory &)=delete |
+auto | CreateMessage () const -> MessagePtr override |
+auto | CreateMessage (const std::size_t size) const -> MessagePtr override |
+auto | CreateMessage (void *data, const std::size_t size, fairmq_free_fn *ffn, void *hint=nullptr) const -> MessagePtr override |
+auto | CreateMessage (UnmanagedRegionPtr ®ion, void *data, const std::size_t size, void *hint=nullptr) const -> 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< const FairMQChannel * > &channels) const -> PollerPtr override |
+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, FairMQRegionCallback callback=nullptr) const -> UnmanagedRegionPtr 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 ()=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 |
+virtual FairMQPollerPtr | CreatePoller (const std::vector< FairMQChannel * > &channels) const =0 |
Create a poller for specific channels. | |
+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 FairMQProgOptions *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 (implemented with ZeroMQ + libfabric)
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::plugins::Control, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> void (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 |
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 |
GetProperty(const std::string &key) const -> T (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const -> std::string (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(const std::string name, const Version version, const std::string maintainer, const 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 |
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 |
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.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | Control (const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) |
![]() | |
+ | Plugin (const std::string name, const Version version, const std::string maintainer, const 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) -> void |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+template<typename T > | |
auto | GetProperty (const std::string &key) const -> T |
+auto | GetPropertyAsString (const std::string &key) const -> std::string |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::plugins::DDS, including all inherited members.
+ChangeDeviceState(const DeviceStateTransition next) -> void (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 | |
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 |
GetProperty(const std::string &key) const -> T (defined in fair::mq::Plugin) | fair::mq::Plugin | inline |
GetPropertyAsString(const std::string &key) const -> std::string (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(const std::string name, const Version version, const std::string maintainer, const 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 |
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 |
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.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | DDS (const std::string &name, const Plugin::Version version, const std::string &maintainer, const std::string &homepage, PluginServices *pluginServices) |
![]() | |
+ | Plugin (const std::string name, const Version version, const std::string maintainer, const 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) -> void |
+auto | SubscribeToDeviceStateChange (std::function< void(DeviceState)> callback) -> void |
+auto | UnsubscribeFromDeviceStateChange () -> void |
+auto | PropertyExists (const std::string &key) -> int |
+template<typename T > | |
auto | SetProperty (const std::string &key, T val) -> void |
+template<typename T > | |
auto | GetProperty (const std::string &key) const -> T |
+auto | GetPropertyAsString (const std::string &key) const -> std::string |
+auto | GetChannelInfo () const -> std::unordered_map< std::string, int > |
+auto | GetPropertyKeys () const -> std::vector< std::string > |
+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.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::shmem::Manager, including all inherited members.
+CreateRegion(const size_t size, const uint64_t id, FairMQRegionCallback callback) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
GetRemoteRegion(const uint64_t id) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Interrupt() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | static |
ManagementSegment() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Manager(const std::string &name, 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 |
RemoveRegion(const uint64_t id) (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
RemoveSegment() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | |
Resume() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager | static |
Segment() (defined in fair::mq::shmem::Manager) | fair::mq::shmem::Manager |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | Manager (const std::string &name, size_t size) |
+ | Manager (const Manager &)=delete |
+Manager | operator= (const Manager &)=delete |
+boost::interprocess::managed_shared_memory & | Segment () |
+boost::interprocess::mapped_region * | CreateRegion (const size_t size, const uint64_t id, FairMQRegionCallback callback) |
+Region * | GetRemoteRegion (const uint64_t id) |
+void | RemoveRegion (const uint64_t id) |
+void | RemoveSegment () |
+boost::interprocess::managed_shared_memory & | ManagementSegment () |
+Static Public Member Functions | |
+static void | Interrupt () |
+static void | Resume () |
+Friends | |
+struct | Region |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 &sessionName) (defined in fair::mq::shmem::Monitor) | fair::mq::shmem::Monitor | static |
Monitor(const std::string &sessionName, bool selfDestruct, bool interactive, 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 | |
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.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | Monitor (const std::string &sessionName, bool selfDestruct, bool interactive, 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 &sessionName) |
+static void | RemoveObject (const std::string &) |
+static void | RemoveQueue (const std::string &) |
+static void | RemoveMutex (const std::string &) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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:
+
|
+ +inline | +
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.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Files | |
file | FairMQSuboptParser.cxx |
Parser implementation for key-value subopt format. | |
file | FairMQSuboptParser.h [code] |
Parser implementation for key-value subopt format. | |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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 | |
Message.h | |
Poller.h | |
Socket.h | |
TransportFactory.h | |
▼ options | |
FairMQParser.h | |
FairMQProgOptions.h | |
FairMQSuboptParser.cxx | Parser implementation for key-value subopt format |
FairMQSuboptParser.h | Parser implementation for key-value subopt format |
FairProgOptions.h | |
FairProgOptionsHelper.h | |
▼ plugins | |
▼ DDS | |
DDS.h | |
Builtin.h | |
Control.h | |
▼ shmem | |
Common.h | |
FairMQMessageSHM.h | |
FairMQPollerSHM.h | |
FairMQSocketSHM.h | |
FairMQTransportFactorySHM.h | |
FairMQUnmanagedRegionSHM.h | |
Manager.h | |
Monitor.h | |
Region.h | |
▼ tools | |
CppSTL.h | |
Network.h | |
Process.h | |
RateLimit.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 | |
FairMQStateMachine.h | |
FairMQTransportFactory.h | |
FairMQUnmanagedRegion.h | |
MemoryResources.h | |
MemoryResourceTools.h | |
Plugin.h | |
PluginManager.h | |
PluginServices.h | |
runFairMQDevice.h | |
StateMachine.h | |
Tools.h | |
Transports.h |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.3.9
+
+ C++ Message Passing Framework
+ |
+
Cfair::mq::ofi::Context::Address | |
Cfair::mq::fsm::Machine_::AutomaticFct | |
Cfair::mq::ofi::Context | Transport-wide context |
Cfair::mq::plugins::DDSConfig | |
Cfair::mq::fsm::Machine_::DefaultFct | |
Cfair::mq::shmem::DeviceCounter | |
Cfair::mq::DeviceRunner | Utility class to facilitate a convenient top-level device launch/shutdown |
Cfair::mq::fsm::END_FSM_EVENT | |
Cfair::mq::fsm::ERROR_FOUND_FSM_EVENT | |
Cfair::mq::fsm::Machine_::ErrorFoundFct | |
Cfair::mq::Event< K > | |
►Cfair::mq::Event< DeviceRunner & > | |
►Cfair::mq::Event< State > | |
►Cfair::mq::Event< std::string > | |
Cfair::mq::EventManager | Manages event callbacks from different subscribers |
Cfair::mq::tools::execute_result | |
Cfair::mq::fsm::Machine_::ExitingFct | |
CFairMQChannel | |
►CFairMQMessage | |
CFairMQParts | FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage, used for sending multi-part messages |
►CFairMQPoller | |
CFairMQProgOptions | |
►CFairMQSocket | |
►CFairMQStateMachine | |
►CFairMQTransportFactory | |
►CFairMQUnmanagedRegion | |
Cfair::mq::tools::HashEnum< Enum > | |
►Cfair::mq::tools::HashEnum< fair::mq::Transport > | |
►Cfair::mq::tools::HashEnum< FairMQStateMachine::Event > | |
Cfair::mq::fsm::INIT_DEVICE_FSM_EVENT | |
Cfair::mq::fsm::INIT_TASK_FSM_EVENT | |
Cfair::mq::fsm::internal_DEVICE_READY_FSM_EVENT | |
Cfair::mq::fsm::internal_IDLE_FSM_EVENT | |
Cfair::mq::fsm::internal_READY_FSM_EVENT | |
Cfair::mq::fsm::Machine_::InternalStopFct | |
►Cinvalid_argument | |
Cfair::mq::plugins::IofN | |
Cfair::mq::parser::JSON | |
Cfair::mq::shmem::Manager | |
►Cmemory_resource | |
Cfair::mq::shmem::MetaHeader | |
Cfair::mq::shmem::Monitor | |
Cfair::mq::shmem::MonitorStatus | |
Cfair::mq::fsm::PAUSE_FSM_EVENT | |
Cfair::mq::fsm::Machine_::PauseFct | |
►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 |
Cfair::mq::tools::RateLimiter | |
Cfair::mq::shmem::Region | |
Cfair::mq::shmem::RegionBlock | |
Cfair::mq::shmem::RegionCounter | |
Cfair::mq::fsm::RESET_DEVICE_FSM_EVENT | |
Cfair::mq::fsm::RESET_TASK_FSM_EVENT | |
Cfair::mq::fsm::RUN_FSM_EVENT | |
►Cruntime_error | |
►Cstate | |
►Cstate_machine_def | |
Cfair::mq::StateMachine | Implements the state machine for FairMQ devices |
Cfair::mq::fsm::STOP_FSM_EVENT | |
Cfair::mq::fsm::Machine_::StopFct | |
Cfair::mq::parser::SUBOPT | |
►CT | |
Cfair::mq::plugins::terminal_config | |
►Cterminate_state | |
Cfair::mq::options::ToString | |
Cfair::mq::options::ToVarValInfo | |
Cfair::mq::VarValInfo | |
►Cvector | |
Cfair::mq::tools::Version |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing 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.
+Supported platforms: Linux and MacOS.
+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
, PROTOBUF
, 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, too.
Of course, feel free to customize the above commands 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.
+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_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_ROOT} | the actual installation prefix, notice the difference to the hint variable FAIRMQ_ROOT |
${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 built-time |
${FairMQ_CXX_STANDARD} | the value of CMAKE_CXX_STANDARD at built-time |
${FairMQ_CXX_EXTENSIONS} | the values of CMAKE_CXX_EXTENSIONS at built-time |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
t |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
Tools for interfacing containers to the transport via polymorphic allocators. +More...
+Tools for interfacing containers to the transport via polymorphic allocators.
+ +FairMQShmManager.h
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
Nfair | Tools for interfacing containers to the transport via polymorphic allocators |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
Todo List |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::ConvertVariableValue< T >, including all inherited members.
+operator()(const boost::program_options::variable_value &varVal) -> typename T::returned_type (defined in fair::mq::ConvertVariableValue< T >) | fair::mq::ConvertVariableValue< T > | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+auto | operator() (const boost::program_options::variable_value &varVal) -> typename T::returned_type |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::Event< K >, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< K >) | fair::mq::Event< K > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Types | |
+using | KeyType = K |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::PropertyChange, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< std::string >) | fair::mq::Event< std::string > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = std::string |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::PropertyChangeAsString, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< std::string >) | fair::mq::Event< std::string > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = std::string |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::StateMachine::StateChange, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< State >) | fair::mq::Event< State > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = State |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::StateMachine::StateQueued, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< State >) | fair::mq::Event< State > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = State |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::VarValInfo, including all inherited members.
+defaulted (defined in fair::mq::VarValInfo) | fair::mq::VarValInfo | |
type (defined in fair::mq::VarValInfo) | fair::mq::VarValInfo | |
value (defined in fair::mq::VarValInfo) | fair::mq::VarValInfo |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Attributes | |
+std::string | value |
+std::string | type |
+std::string | defaulted |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::DEVICE_READY_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::DEVICE_READY_FSM_STATE) | fair::mq::fsm::DEVICE_READY_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::DEVICE_READY_FSM_STATE) | fair::mq::fsm::DEVICE_READY_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::END_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::END_FSM_EVENT) | fair::mq::fsm::END_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::END_FSM_EVENT) | fair::mq::fsm::END_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::ERROR_FOUND_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::ERROR_FOUND_FSM_EVENT) | fair::mq::fsm::ERROR_FOUND_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::ERROR_FOUND_FSM_EVENT) | fair::mq::fsm::ERROR_FOUND_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::ERROR_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::ERROR_FSM_STATE) | fair::mq::fsm::ERROR_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::ERROR_FSM_STATE) | fair::mq::fsm::ERROR_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::EXITING_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::EXITING_FSM_STATE) | fair::mq::fsm::EXITING_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::EXITING_FSM_STATE) | fair::mq::fsm::EXITING_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::IDLE_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::IDLE_FSM_STATE) | fair::mq::fsm::IDLE_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::IDLE_FSM_STATE) | fair::mq::fsm::IDLE_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::INITIALIZING_DEVICE_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::INITIALIZING_DEVICE_FSM_STATE) | fair::mq::fsm::INITIALIZING_DEVICE_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::INITIALIZING_DEVICE_FSM_STATE) | fair::mq::fsm::INITIALIZING_DEVICE_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::INITIALIZING_TASK_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::INITIALIZING_TASK_FSM_STATE) | fair::mq::fsm::INITIALIZING_TASK_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::INITIALIZING_TASK_FSM_STATE) | fair::mq::fsm::INITIALIZING_TASK_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::INIT_DEVICE_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::INIT_DEVICE_FSM_EVENT) | fair::mq::fsm::INIT_DEVICE_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::INIT_DEVICE_FSM_EVENT) | fair::mq::fsm::INIT_DEVICE_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::INIT_TASK_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::INIT_TASK_FSM_EVENT) | fair::mq::fsm::INIT_TASK_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::INIT_TASK_FSM_EVENT) | fair::mq::fsm::INIT_TASK_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_, including all inherited members.
+CallStateChangeCallbacks(const FairMQStateMachine::State state) const (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | inline |
fState (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fStateChangeSignal (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fStateChangeSignalsMap (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fStateHandlers (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fUnblockHandler (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fWork (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fWorkActive (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fWorkAvailable (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fWorkAvailableCondition (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fWorkDoneCondition (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fWorkerTerminated (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
fWorkMutex (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
initial_state typedef (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | |
Machine_() (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | inline |
no_transition(Event const &e, FSM &, int state) (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | inline |
on_entry(Event const &, FSM &) (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | inline |
on_exit(Event const &, FSM &) (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | inline |
ProcessWork() (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | inline |
~Machine_() (defined in fair::mq::fsm::Machine_) | fair::mq::fsm::Machine_ | inlinevirtual |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Classes | |
struct | AutomaticFct |
struct | DefaultFct |
struct | ErrorFoundFct |
struct | ExitingFct |
struct | InternalStopFct |
struct | PauseFct |
struct | StopFct |
struct | transition_table |
+Public Types | |
+using | initial_state = boost::mpl::vector< IDLE_FSM_STATE, OK_FSM_STATE > |
+Public Member Functions | |
+template<typename Event , typename FSM > | |
void | on_entry (Event const &, FSM &) |
+template<typename Event , typename FSM > | |
void | on_exit (Event const &, FSM &) |
+template<typename FSM , typename Event > | |
void | no_transition (Event const &e, FSM &, int state) |
+void | CallStateChangeCallbacks (const FairMQStateMachine::State state) const |
+void | ProcessWork () |
+Public Attributes | |
+function< void(void)> | fUnblockHandler |
+unordered_map< FairMQStateMachine::Event, function< void(void)> > | fStateHandlers |
+function< void(void)> | fWork |
+condition_variable | fWorkAvailableCondition |
+condition_variable | fWorkDoneCondition |
+mutex | fWorkMutex |
+bool | fWorkerTerminated |
+bool | fWorkActive |
+bool | fWorkAvailable |
+boost::signals2::signal< void(const FairMQStateMachine::State)> | fStateChangeSignal |
+unordered_map< string, boost::signals2::connection > | fStateChangeSignalsMap |
+atomic< FairMQStateMachine::State > | fState |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_::AutomaticFct, including all inherited members.
+operator()(EVT const &, FSM &fsm, SourceState &, TargetState &ts) (defined in fair::mq::fsm::Machine_::AutomaticFct) | fair::mq::fsm::Machine_::AutomaticFct | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+template<typename EVT , typename FSM , typename SourceState , typename TargetState > | |
void | operator() (EVT const &, FSM &fsm, SourceState &, TargetState &ts) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_::DefaultFct, including all inherited members.
+operator()(EVT const &e, FSM &fsm, SourceState &, TargetState &ts) (defined in fair::mq::fsm::Machine_::DefaultFct) | fair::mq::fsm::Machine_::DefaultFct | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+template<typename EVT , typename FSM , typename SourceState , typename TargetState > | |
void | operator() (EVT const &e, FSM &fsm, SourceState &, TargetState &ts) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_::ErrorFoundFct, including all inherited members.
+operator()(EVT const &, FSM &fsm, SourceState &, TargetState &ts) (defined in fair::mq::fsm::Machine_::ErrorFoundFct) | fair::mq::fsm::Machine_::ErrorFoundFct | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+template<typename EVT , typename FSM , typename SourceState , typename TargetState > | |
void | operator() (EVT const &, FSM &fsm, SourceState &, TargetState &ts) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_::ExitingFct, including all inherited members.
+operator()(EVT const &e, FSM &fsm, SourceState &, TargetState &ts) (defined in fair::mq::fsm::Machine_::ExitingFct) | fair::mq::fsm::Machine_::ExitingFct | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+template<typename EVT , typename FSM , typename SourceState , typename TargetState > | |
void | operator() (EVT const &e, FSM &fsm, SourceState &, TargetState &ts) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_::InternalStopFct, including all inherited members.
+operator()(EVT const &, FSM &fsm, SourceState &, TargetState &ts) (defined in fair::mq::fsm::Machine_::InternalStopFct) | fair::mq::fsm::Machine_::InternalStopFct | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+template<typename EVT , typename FSM , typename SourceState , typename TargetState > | |
void | operator() (EVT const &, FSM &fsm, SourceState &, TargetState &ts) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_::PauseFct, including all inherited members.
+operator()(EVT const &, FSM &fsm, SourceState &, TargetState &ts) (defined in fair::mq::fsm::Machine_::PauseFct) | fair::mq::fsm::Machine_::PauseFct | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+template<typename EVT , typename FSM , typename SourceState , typename TargetState > | |
void | operator() (EVT const &, FSM &fsm, SourceState &, TargetState &ts) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::Machine_::StopFct, including all inherited members.
+operator()(EVT const &, FSM &fsm, SourceState &, TargetState &ts) (defined in fair::mq::fsm::Machine_::StopFct) | fair::mq::fsm::Machine_::StopFct | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+template<typename EVT , typename FSM , typename SourceState , typename TargetState > | |
void | operator() (EVT const &, FSM &fsm, SourceState &, TargetState &ts) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::OK_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::OK_FSM_STATE) | fair::mq::fsm::OK_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::OK_FSM_STATE) | fair::mq::fsm::OK_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::PAUSED_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::PAUSED_FSM_STATE) | fair::mq::fsm::PAUSED_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::PAUSED_FSM_STATE) | fair::mq::fsm::PAUSED_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::PAUSE_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::PAUSE_FSM_EVENT) | fair::mq::fsm::PAUSE_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::PAUSE_FSM_EVENT) | fair::mq::fsm::PAUSE_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::READY_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::READY_FSM_STATE) | fair::mq::fsm::READY_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::READY_FSM_STATE) | fair::mq::fsm::READY_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::RESETTING_DEVICE_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::RESETTING_DEVICE_FSM_STATE) | fair::mq::fsm::RESETTING_DEVICE_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::RESETTING_DEVICE_FSM_STATE) | fair::mq::fsm::RESETTING_DEVICE_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::RESETTING_TASK_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::RESETTING_TASK_FSM_STATE) | fair::mq::fsm::RESETTING_TASK_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::RESETTING_TASK_FSM_STATE) | fair::mq::fsm::RESETTING_TASK_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::RESET_DEVICE_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::RESET_DEVICE_FSM_EVENT) | fair::mq::fsm::RESET_DEVICE_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::RESET_DEVICE_FSM_EVENT) | fair::mq::fsm::RESET_DEVICE_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::RESET_TASK_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::RESET_TASK_FSM_EVENT) | fair::mq::fsm::RESET_TASK_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::RESET_TASK_FSM_EVENT) | fair::mq::fsm::RESET_TASK_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::RUNNING_FSM_STATE, including all inherited members.
+Name() (defined in fair::mq::fsm::RUNNING_FSM_STATE) | fair::mq::fsm::RUNNING_FSM_STATE | inlinestatic |
Type() (defined in fair::mq::fsm::RUNNING_FSM_STATE) | fair::mq::fsm::RUNNING_FSM_STATE | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::State | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::RUN_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::RUN_FSM_EVENT) | fair::mq::fsm::RUN_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::RUN_FSM_EVENT) | fair::mq::fsm::RUN_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::STOP_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::STOP_FSM_EVENT) | fair::mq::fsm::STOP_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::STOP_FSM_EVENT) | fair::mq::fsm::STOP_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::internal_DEVICE_READY_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::internal_DEVICE_READY_FSM_EVENT) | fair::mq::fsm::internal_DEVICE_READY_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::internal_DEVICE_READY_FSM_EVENT) | fair::mq::fsm::internal_DEVICE_READY_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::internal_IDLE_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::internal_IDLE_FSM_EVENT) | fair::mq::fsm::internal_IDLE_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::internal_IDLE_FSM_EVENT) | fair::mq::fsm::internal_IDLE_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::fsm::internal_READY_FSM_EVENT, including all inherited members.
+Name() (defined in fair::mq::fsm::internal_READY_FSM_EVENT) | fair::mq::fsm::internal_READY_FSM_EVENT | inlinestatic |
Type() (defined in fair::mq::fsm::internal_READY_FSM_EVENT) | fair::mq::fsm::internal_READY_FSM_EVENT | inlinestatic |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Static Public Member Functions | |
+static string | Name () |
+static FairMQStateMachine::Event | Type () |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::hooks::InstantiateDevice, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< DeviceRunner & >) | fair::mq::Event< DeviceRunner & > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = DeviceRunner & |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::hooks::LoadPlugins, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< DeviceRunner & >) | fair::mq::Event< DeviceRunner & > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = DeviceRunner & |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::hooks::ModifyRawCmdLineArgs, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< DeviceRunner & >) | fair::mq::Event< DeviceRunner & > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = DeviceRunner & |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::hooks::SetCustomCmdLineOptions, including all inherited members.
+KeyType typedef (defined in fair::mq::Event< DeviceRunner & >) | fair::mq::Event< DeviceRunner & > |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+using | KeyType = DeviceRunner & |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::ofi::Context::Address, including all inherited members.
+Ip (defined in fair::mq::ofi::Context::Address) | fair::mq::ofi::Context::Address | |
operator<< (defined in fair::mq::ofi::Context::Address) | fair::mq::ofi::Context::Address | friend |
Port (defined in fair::mq::ofi::Context::Address) | fair::mq::ofi::Context::Address | |
Protocol (defined in fair::mq::ofi::Context::Address) | fair::mq::ofi::Context::Address |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Attributes | |
+std::string | Protocol |
+std::string | Ip |
+unsigned int | Port |
+Friends | |
+auto | operator<< (std::ostream &os, const Address &a) -> std::ostream & |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::options::ToString, including all inherited members.
+DefaultValue(const std::string &) (defined in fair::mq::options::ToString) | fair::mq::options::ToString | inline |
returned_type typedef (defined in fair::mq::options::ToString) | fair::mq::options::ToString | |
Value(const boost::program_options::variable_value &varVal, const std::string &, const std::string &) (defined in fair::mq::options::ToString) | fair::mq::options::ToString | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Types | |
+using | returned_type = std::string |
+Public Member Functions | |
+template<typename T > | |
std::string | Value (const boost::program_options::variable_value &varVal, const std::string &, const std::string &) |
+returned_type | DefaultValue (const std::string &) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::options::ToVarValInfo, including all inherited members.
+DefaultValue(const std::string &defaulted) (defined in fair::mq::options::ToVarValInfo) | fair::mq::options::ToVarValInfo | inline |
returned_type typedef (defined in fair::mq::options::ToVarValInfo) | fair::mq::options::ToVarValInfo | |
Value(const boost::program_options::variable_value &varVal, const std::string &type, const std::string &defaulted) (defined in fair::mq::options::ToVarValInfo) | fair::mq::options::ToVarValInfo | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Types | |
+using | returned_type = VarValInfo |
+Public Member Functions | |
+template<typename T > | |
returned_type | Value (const boost::program_options::variable_value &varVal, const std::string &type, const std::string &defaulted) |
+returned_type | DefaultValue (const std::string &defaulted) |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::parser::JSON, including all inherited members.
+UserParser(const std::string &filename, const std::string &deviceId, const std::string &rootNode="fairMQOptions") (defined in fair::mq::parser::JSON) | fair::mq::parser::JSON |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+FairMQChannelMap | UserParser (const std::string &filename, const std::string &deviceId, const std::string &rootNode="fairMQOptions") |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::parser::SUBOPT, including all inherited members.
+ADDRESS enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
AUTOBIND enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
channelOptionKeyIds enum name (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
channelOptionKeys (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | static |
lastsocketkey enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
LINGER enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
METHOD enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
NAME enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
NUMSOCKETS enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
PORTRANGEMAX enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
PORTRANGEMIN enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
RATELOGGING enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
RCVBUFSIZE enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
RCVKERNELSIZE enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
SNDBUFSIZE enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
SNDKERNELSIZE enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
TRANSPORT enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
TYPE enum value (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT | |
UserParser(const std::vector< std::string > &channelConfig, const std::string &deviceId, const std::string &rootNode="fairMQOptions") (defined in fair::mq::parser::SUBOPT) | fair::mq::parser::SUBOPT |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
#include <FairMQSuboptParser.h>
+Public Types | |
enum | channelOptionKeyIds { + NAME = 0, +TYPE, +METHOD, +ADDRESS, + + TRANSPORT, +SNDBUFSIZE, +RCVBUFSIZE, +SNDKERNELSIZE, + + RCVKERNELSIZE, +LINGER, +RATELOGGING, +PORTRANGEMIN, + + PORTRANGEMAX, +AUTOBIND, +NUMSOCKETS, +lastsocketkey + + } |
+Public Member Functions | |
+FairMQChannelMap | UserParser (const std::vector< std::string > &channelConfig, const std::string &deviceId, const std::string &rootNode="fairMQOptions") |
+Static Public Attributes | |
static constexpr const char * | channelOptionKeys [] |
A parser implementation for FairMQ channel properties. The parser handles a comma separated key=value list format by using the getsubopt function of the standard library.
+The option key '–channel-config' can be used with the list of key/value pairs like e.g.
+--channel-config name=output,type=push,method=bind +
The FairMQ option parser defines a 'UserParser' function for different formats. Currently it is strictly parsing channel options, but in general the concept is extensible by renaming UserParser to ChannelPropertyParser and introducing additional parser functions.
+
+
|
+ +static | +
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::plugins::DDSConfig, including all inherited members.
+DDSConfig() (defined in fair::mq::plugins::DDSConfig) | fair::mq::plugins::DDSConfig | inline |
fDDSValues (defined in fair::mq::plugins::DDSConfig) | fair::mq::plugins::DDSConfig | |
fSubChannelAddresses (defined in fair::mq::plugins::DDSConfig) | fair::mq::plugins::DDSConfig |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Attributes | |
+std::vector< std::string > | fSubChannelAddresses |
+std::unordered_map< uint64_t, std::string > | fDDSValues |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::plugins::IofN, including all inherited members.
+fEntries (defined in fair::mq::plugins::IofN) | fair::mq::plugins::IofN | |
fI (defined in fair::mq::plugins::IofN) | fair::mq::plugins::IofN | |
fN (defined in fair::mq::plugins::IofN) | fair::mq::plugins::IofN | |
IofN(int i, int n) (defined in fair::mq::plugins::IofN) | fair::mq::plugins::IofN | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | IofN (int i, int n) |
+Public Attributes | |
+unsigned int | fI |
+unsigned int | fN |
+std::vector< std::string > | fEntries |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::plugins::terminal_config, including all inherited members.
+terminal_config() (defined in fair::mq::plugins::terminal_config) | fair::mq::plugins::terminal_config | inline |
~terminal_config() (defined in fair::mq::plugins::terminal_config) | fair::mq::plugins::terminal_config | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::shmem::DeviceCounter, including all inherited members.
+DeviceCounter(unsigned int c) (defined in fair::mq::shmem::DeviceCounter) | fair::mq::shmem::DeviceCounter | inline |
fCount (defined in fair::mq::shmem::DeviceCounter) | fair::mq::shmem::DeviceCounter |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | DeviceCounter (unsigned int c) |
+Public Attributes | |
+std::atomic< unsigned int > | fCount |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::shmem::MetaHeader, including all inherited members.
+fHandle (defined in fair::mq::shmem::MetaHeader) | fair::mq::shmem::MetaHeader | |
fHint (defined in fair::mq::shmem::MetaHeader) | fair::mq::shmem::MetaHeader | |
fRegionId (defined in fair::mq::shmem::MetaHeader) | fair::mq::shmem::MetaHeader | |
fSize (defined in fair::mq::shmem::MetaHeader) | fair::mq::shmem::MetaHeader |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Attributes | |
+size_t | fSize |
+size_t | fRegionId |
+boost::interprocess::managed_shared_memory::handle_t | fHandle |
+size_t | fHint |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::shmem::MonitorStatus, including all inherited members.
+fActive (defined in fair::mq::shmem::MonitorStatus) | fair::mq::shmem::MonitorStatus | |
MonitorStatus() (defined in fair::mq::shmem::MonitorStatus) | fair::mq::shmem::MonitorStatus | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Attributes | |
+bool | fActive |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::shmem::Region, including all inherited members.
+fCallback (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fManager (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fName (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fQueue (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fQueueName (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fRegion (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fRemote (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fShmemObject (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fStop (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
fWorker (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
ReceiveAcks() (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
Region(Manager &manager, uint64_t id, uint64_t size, bool remote, FairMQRegionCallback callback=nullptr) (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
Region()=delete (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
Region(const Region &)=default (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
Region(Region &&)=default (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
StartReceivingAcks() (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region | |
~Region() (defined in fair::mq::shmem::Region) | fair::mq::shmem::Region |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | Region (Manager &manager, uint64_t id, uint64_t size, bool remote, FairMQRegionCallback callback=nullptr) |
+ | Region (const Region &)=default |
+ | Region (Region &&)=default |
+void | StartReceivingAcks () |
+void | ReceiveAcks () |
+Public Attributes | |
+Manager & | fManager |
+bool | fRemote |
+bool | fStop |
+std::string | fName |
+std::string | fQueueName |
+boost::interprocess::shared_memory_object | fShmemObject |
+boost::interprocess::mapped_region | fRegion |
+std::unique_ptr< boost::interprocess::message_queue > | fQueue |
+std::thread | fWorker |
+FairMQRegionCallback | fCallback |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::shmem::RegionBlock, including all inherited members.
+fHandle (defined in fair::mq::shmem::RegionBlock) | fair::mq::shmem::RegionBlock | |
fHint (defined in fair::mq::shmem::RegionBlock) | fair::mq::shmem::RegionBlock | |
fSize (defined in fair::mq::shmem::RegionBlock) | fair::mq::shmem::RegionBlock | |
RegionBlock() (defined in fair::mq::shmem::RegionBlock) | fair::mq::shmem::RegionBlock | inline |
RegionBlock(boost::interprocess::managed_shared_memory::handle_t handle, size_t size, size_t hint) (defined in fair::mq::shmem::RegionBlock) | fair::mq::shmem::RegionBlock | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | RegionBlock (boost::interprocess::managed_shared_memory::handle_t handle, size_t size, size_t hint) |
+Public Attributes | |
+boost::interprocess::managed_shared_memory::handle_t | fHandle |
+size_t | fSize |
+size_t | fHint |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::shmem::RegionCounter, including all inherited members.
+fCount (defined in fair::mq::shmem::RegionCounter) | fair::mq::shmem::RegionCounter | |
RegionCounter(unsigned int c) (defined in fair::mq::shmem::RegionCounter) | fair::mq::shmem::RegionCounter | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+ | RegionCounter (unsigned int c) |
+Public Attributes | |
+std::atomic< unsigned int > | fCount |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::tools::HashEnum< Enum >, including all inherited members.
+operator()(const Enum &e) const noexcept -> typename std::enable_if< std::is_enum< Enum >::value, std::size_t >::type (defined in fair::mq::tools::HashEnum< Enum >) | fair::mq::tools::HashEnum< Enum > | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Member Functions | |
+auto | operator() (const Enum &e) const noexcept -> typename std::enable_if< std::is_enum< Enum >::value, std::size_t >::type |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::tools::Version, including all inherited members.
+fkMajor (defined in fair::mq::tools::Version) | fair::mq::tools::Version | |
fkMinor (defined in fair::mq::tools::Version) | fair::mq::tools::Version | |
fkPatch (defined in fair::mq::tools::Version) | fair::mq::tools::Version | |
operator!= (defined in fair::mq::tools::Version) | fair::mq::tools::Version | friend |
operator< (defined in fair::mq::tools::Version) | fair::mq::tools::Version | friend |
operator<< (defined in fair::mq::tools::Version) | fair::mq::tools::Version | friend |
operator<= (defined in fair::mq::tools::Version) | fair::mq::tools::Version | friend |
operator== (defined in fair::mq::tools::Version) | fair::mq::tools::Version | friend |
operator> (defined in fair::mq::tools::Version) | fair::mq::tools::Version | friend |
operator>= (defined in fair::mq::tools::Version) | fair::mq::tools::Version | friend |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Public Attributes | |
+const int | fkMajor |
+const int | fkMinor |
+const int | fkPatch |
+Friends | |
+auto | operator< (const Version &lhs, const Version &rhs) -> bool |
+auto | operator> (const Version &lhs, const Version &rhs) -> bool |
+auto | operator<= (const Version &lhs, const Version &rhs) -> bool |
+auto | operator>= (const Version &lhs, const Version &rhs) -> bool |
+auto | operator== (const Version &lhs, const Version &rhs) -> bool |
+auto | operator!= (const Version &lhs, const Version &rhs) -> bool |
+auto | operator<< (std::ostream &os, const Version &v) -> std::ostream & |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for fair::mq::tools::execute_result, including all inherited members.
+console_out (defined in fair::mq::tools::execute_result) | fair::mq::tools::execute_result | |
exit_code (defined in fair::mq::tools::execute_result) | fair::mq::tools::execute_result |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
#include <Process.h>
+Public Attributes | |
+std::string | console_out |
+int | exit_code |
Result type for execute function. Holds captured stdout output and exit code.
+
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for std::hash< FairMQStateMachine::Event >, including all inherited members.
+operator()(const FairMQStateMachine::Event &e) const noexcept -> typename std::enable_if< std::is_enum< FairMQStateMachine::Event >::value, std::size_t >::type (defined in fair::mq::tools::HashEnum< FairMQStateMachine::Event >) | fair::mq::tools::HashEnum< FairMQStateMachine::Event > | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+auto | operator() (const FairMQStateMachine::Event &e) const noexcept -> typename std::enable_if< std::is_enum< FairMQStateMachine::Event >::value, std::size_t >::type |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
This is the complete list of members for std::hash< fair::mq::Transport >, including all inherited members.
+operator()(const fair::mq::Transport &e) const noexcept -> typename std::enable_if< std::is_enum< fair::mq::Transport >::value, std::size_t >::type (defined in fair::mq::tools::HashEnum< fair::mq::Transport >) | fair::mq::tools::HashEnum< fair::mq::Transport > | inline |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+
+Additional Inherited Members | |
![]() | |
+auto | operator() (const fair::mq::Transport &e) const noexcept -> typename std::enable_if< std::is_enum< fair::mq::Transport >::value, std::size_t >::type |
+ FairMQ
+ 1.3.9
+
+ C++ Message Passing Framework
+ |
+