Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-15 17:41:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

SDK: Add inline docs

Browse Source
This commit is contained in:
Dennis Klein
2020-01-27 19:13:19 +01:00
committed by Dennis Klein
parent 92af823135
commit be524d838a
1 changed files with 38 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
fairmq/sdk/Topology.h
View File

@@ -401,7 +401,6 @@ class BasicTopology : public AsioBase<Executor, Allocator>
/// @brief Perform state transition on all FairMQ devices in this topology
/// @param transition FairMQ device state machine transition
/// @param timeout Timeout in milliseconds, 0 means no timeout
/// @tparam CompletionToken Asio completion token type
/// @throws std::system_error
auto ChangeState(const TopologyTransition transition, Duration timeout = Duration(0))
-> std::pair<std::error_code, TopologyState>
@@ -522,6 +521,13 @@ class BasicTopology : public AsioBase<Executor, Allocator>
}
public:
/// @brief Initiate property query on selected FairMQ devices in this topology
/// @param query Key(s) to be queried (regex)
/// @param path Select a subset of FairMQ devices in this topology, empty selects all
/// @param timeout Timeout in milliseconds, 0 means no timeout
/// @param token Asio completion token
/// @tparam CompletionToken Asio completion token type
/// @throws std::system_error
template<typename CompletionToken>
auto AsyncGetProperties(DevicePropertyQuery const& query,
const std::string& path,
@@ -532,6 +538,7 @@ class BasicTopology : public AsioBase<Executor, Allocator>
[&](auto handler) {
typename GetPropertiesOp::Id const id(tools::UuidHash());
// TODO Implement garbage collection of completed ops
std::lock_guard<std::mutex> lk(fMtx);
fGetPropertiesOps.emplace(
std::piecewise_construct,
@@ -550,12 +557,22 @@ class BasicTopology : public AsioBase<Executor, Allocator>
token);
}
/// @brief Initiate property query on selected FairMQ devices in this topology
/// @param query Key(s) to be queried (regex)
/// @param token Asio completion token
/// @tparam CompletionToken Asio completion token type
/// @throws std::system_error
template<typename CompletionToken>
auto AsyncGetProperties(DevicePropertyQuery const& query, CompletionToken&& token)
{
return AsyncGetProperties(query, "", Duration(0), std::move(token));
}
/// @brief Query properties on selected FairMQ devices in this topology
/// @param query Key(s) to be queried (regex)
/// @param path Select a subset of FairMQ devices in this topology, empty selects all
/// @param timeout Timeout in milliseconds, 0 means no timeout
/// @throws std::system_error
auto GetProperties(DevicePropertyQuery const& query, const std::string& path = "", Duration timeout = Duration(0))
-> std::pair<std::error_code, GetPropertiesResult>
{
@@ -661,6 +678,13 @@ class BasicTopology : public AsioBase<Executor, Allocator>
}
public:
/// @brief Initiate property update on selected FairMQ devices in this topology
/// @param props Properties to set
/// @param path Select a subset of FairMQ devices in this topology, empty selects all
/// @param timeout Timeout in milliseconds, 0 means no timeout
/// @param token Asio completion token
/// @tparam CompletionToken Asio completion token type
/// @throws std::system_error
template<typename CompletionToken>
auto AsyncSetProperties(const DeviceProperties& props,
const std::string& path,
@@ -671,6 +695,7 @@ class BasicTopology : public AsioBase<Executor, Allocator>
[&](auto handler) {
typename SetPropertiesOp::Id const id(tools::UuidHash());
// TODO Implement garbage collection of completed ops
std::lock_guard<std::mutex> lk(fMtx);
fSetPropertiesOps.emplace(
std::piecewise_construct,
@@ -689,12 +714,22 @@ class BasicTopology : public AsioBase<Executor, Allocator>
token);
}
/// @brief Initiate property update on selected FairMQ devices in this topology
/// @param props Properties to set
/// @param token Asio completion token
/// @tparam CompletionToken Asio completion token type
/// @throws std::system_error
template<typename CompletionToken>
auto AsyncSetProperties(DeviceProperties const & properties, CompletionToken&& token)
auto AsyncSetProperties(DeviceProperties const & props, CompletionToken&& token)
{
return AsyncSetProperties(properties, "", Duration(0), std::move(token));
return AsyncSetProperties(props, "", Duration(0), std::move(token));
}
/// @brief Set properties on selected FairMQ devices in this topology
/// @param props Properties to set
/// @param path Select a subset of FairMQ devices in this topology, empty selects all
/// @param timeout Timeout in milliseconds, 0 means no timeout
/// @throws std::system_error
auto SetProperties(DeviceProperties const& properties, const std::string& path = "", Duration timeout = Duration(0))
-> std::pair<std::error_code, FailedDevices>
{