Skip to content
v1.11dev
GitHub

API · fair::mq

PluginServicesclass

#include <fairmq/PluginServices.h>fairmq/PluginServices.h:39GitHub ↗

Facilitates communication between devices and plugins.

  • Configuration interface
  • Control interface

Nested types

Types

Functions

TakeDeviceControl

PluginServices.h:93
auto TakeDeviceControl(const std::string& controller) -> void

Become device controller.

Only one plugin can succeed to take control over device state transitions at a time.

controller
id
fair::mq::PluginServices::DeviceControlError throws
if there is already a device controller.

StealDeviceControl

PluginServices.h:101
auto StealDeviceControl(const std::string& controller) -> void

Become device controller by force.

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).

controller
id

ReleaseDeviceControl

PluginServices.h:106
auto ReleaseDeviceControl(const std::string& controller) -> void

Release device controller role.

controller
id
fair::mq::PluginServices::DeviceControlError throws
if passed controller id is not the current device controller.

ChangeDeviceState

PluginServices.h:122
auto ChangeDeviceState(
    const std::string& controller,
    DeviceStateTransition next
) -> bool

Request a device state transition.

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.

controller
id
next
state transition
fair::mq::PluginServices::DeviceControlError throws
if control role is not currently owned by passed controller id.

SubscribeToDeviceStateChange

PluginServices.h:130
auto SubscribeToDeviceStateChange(
    const std::string& subscriber,
    std::function<void(DeviceState)> callback
) -> void

Subscribe with a callback to device state changes.

The callback will be called at the beginning of a new state. The callback is called from the thread the state is running in.

subscriber
id
callback
—

GetNumberOfConnectedPeers

PluginServices.h:142
auto GetNumberOfConnectedPeers(
    const std::string& channelName,
    int index = 0
) -> unsigned long

DO NOT USE, ONLY FOR TESTING, WILL BE REMOVED (and info made available via property api)

PropertyExists

PluginServices.h:149
auto PropertyExists(const std::string& key) const -> bool

Checks a property with the given key exist in the configuration.

key
—
Returns
true if it exists, false otherwise

SetProperty

templatePluginServices.h:158
template<typename T>
auto SetProperty(const std::string& key, T val) -> void

Set config property.

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.

key
—
val
—

UpdateProperty

templatePluginServices.h:166
template<typename T>
bool UpdateProperty(const std::string& key, T val)

Updates an existing config property (or fails if it doesn't exist)

key
—
val
—

GetProperty

templatePluginServices.h:179
template<typename T>
auto GetProperty(const std::string& key) const -> T

Read config property, throw if no property with this key exists.

key
—
Returns
config property

GetProperty

templatePluginServices.h:186
template<typename T>
T GetProperty(const std::string& key, const T& ifNotFound) const

Read config property, return provided value if no property with this key exists.

key
—
ifNotFound
value to return if key is not found
Returns
config property

GetPropertyAsString

PluginServices.h:195
auto GetPropertyAsString(const std::string& key) const -> std::string

Read config property as string, throw if no property with this key exists.

Supports conversion to string for a fixed set of types, for custom/unsupported types add them via fair::mq::PropertyHelper::AddType<MyType>("optional label") the provided type must then be convertible to string via operator<<

key
—
Returns
config property converted to string

GetPropertyAsString

PluginServices.h:205
auto GetPropertyAsString(
    const std::string& key,
    const std::string& ifNotFound
) const -> std::string

Read config property, return provided value if no property with this key exists.

Supports conversion to string for a fixed set of types, for custom/unsupported types add them via fair::mq::PropertyHelper::AddType<MyType>("optional label") the provided type must then be convertible to string via operator<<

key
—
ifNotFound
value to return if key is not found
Returns
config property converted to string

GetPropertiesAsString

PluginServices.h:220
std::map<std::string, std::string> GetPropertiesAsString(const std::string& q) const

Read several config properties as string whose keys match the provided regular expression.

q
regex string to match for
Returns
container with properties (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any)

GetPropertiesAsStringStartingWith

PluginServices.h:226
std::map<std::string, std::string> GetPropertiesAsStringStartingWith(const std::string& q) const

Read several config properties as string whose keys start with the provided string.

Typically more performant than GetPropertiesAsString with regex

q
string to match for
Returns
container with properties (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any)

GetChannelInfo

PluginServices.h:230
auto GetChannelInfo() const -> std::unordered_map< std::string, int >

Retrieve current channel information.

Returns
a map of <channel name, number of subchannels>

SubscribeToPropertyChange

templatePluginServices.h:242
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.

Subscribe to property changes with a callback to monitor property changes in an event based fashion.

subscriber
—
callback
function

SubscribeToPropertyChangeAsString

PluginServices.h:257
auto SubscribeToPropertyChangeAsString(
    const std::string& subscriber,
    std::function<void(const std::string&key, std::string)> callback
) const -> void

Subscribe to property updates.

Subscribe to property changes with a callback to monitor property changes in an event based fashion. Will convert the property to string.

subscriber
—
callback
function

Static functions

ToDeviceState

staticPluginServices.h:67
static auto ToDeviceState(const std::string& state) -> DeviceState

Convert string to DeviceState.

state
to convert
Returns
DeviceState enum entry
std::out_of_range throws
if a string cannot be resolved to a DeviceState

ToDeviceStateTransition

staticPluginServices.h:73
static auto ToDeviceStateTransition(const std::string& transition) -> DeviceStateTransition

Convert string to DeviceStateTransition.

transition
to convert
Returns
DeviceStateTransition enum entry
std::out_of_range throws
if a string cannot be resolved to a DeviceStateTransition

ToStr

staticPluginServices.h:78
static auto ToStr(DeviceState state) -> std::string

Convert DeviceState to string.

state
to convert
Returns
string representation of DeviceState enum entry