OGLplus  (0.59.0) a C++ wrapper for rendering APIs

eagine::msgbus::remote_node_tracker Class Reference

Class tracking the state of remote message bus nodes. More...

#include <eagine/message_bus/remote_node.hpp>

Public Member Functions

 remote_node_tracker ()
 Default constructor.
 
auto get_node (identifier_t node_id) -> remote_node_state &
 Finds and returns the state information about a remote bus node. More...
 
auto get_host (host_id_t) -> remote_host_state &
 Finds and returns the state information about a remote host. More...
 
auto get_host (host_id_t) const -> remote_host_state
 Finds and returns the state information about a remote host. More...
 
auto get_instance (host_id_t) -> remote_instance_state &
 Finds and returns the information about a remote instance (process). More...
 
auto get_instance (host_id_t) const -> remote_instance_state
 Finds and returns the information about a remote instance (process). More...
 
auto get_connection (identifier_t node_id1, identifier_t node_id2) -> node_connection_state &
 Finds and returns the information about remote node connections. More...
 
auto get_connection (identifier_t node_id1, identifier_t node_id2) const -> node_connection_state
 Finds and returns the information about remote node connections. More...
 
template<typename Function >
void for_each_host (Function func)
 Calls a function on each tracked remote host. More...
 
template<typename Function >
void for_each_host_state (Function func)
 Calls a function on each tracked remote host. More...
 
template<typename Function >
void for_each_node (Function func)
 Calls a function on each tracked remote bus node. More...
 
template<typename Function >
void for_each_node_state (Function func)
 Calls a function on each tracked remote bus node. More...
 
template<typename Function >
void for_each_instance_node_state (process_instance_id_t inst_id, Function func)
 Calls a function on tracked remote bus nodes of an instance (process). More...
 
template<typename Function >
void for_each_host_node_state (host_id_t host_id, Function func)
 Calls a function on tracked remote bus nodes of a remote host. More...
 
template<typename Function >
void for_each_connection (Function func) const
 Calls a function on tracked connections between bus nodes. More...
 

Detailed Description

Class tracking the state of remote message bus nodes.

See also
remote_node_changes

Member Function Documentation

◆ for_each_connection()

template<typename Function >
void eagine::msgbus::remote_node_tracker::for_each_connection ( Function  func) const

Calls a function on tracked connections between bus nodes.

See also
node_connection_state
for_each_node_state

The function is called with (const node_connection&) as argument.

◆ for_each_host()

template<typename Function >
void eagine::msgbus::remote_node_tracker::for_each_host ( Function  func)

Calls a function on each tracked remote host.

See also
remote_host
for_each_host_state
for_each_node

The function is called with (host_id_t, const remote_host&) as arguments.

◆ for_each_host_node_state()

template<typename Function >
void eagine::msgbus::remote_node_tracker::for_each_host_node_state ( host_id_t  host_id,
Function  func 
)

Calls a function on tracked remote bus nodes of a remote host.

See also
remote_node_state
for_each_node_state
for_each_instance_node_state

The function is called with (host_id_t, const remote_node_state&) as arguments. This function is subject to change without notice. Prefer using for_each_node.

◆ for_each_host_state()

template<typename Function >
void eagine::msgbus::remote_node_tracker::for_each_host_state ( Function  func)

Calls a function on each tracked remote host.

See also
remote_host_state
for_each_host
for_each_node

The function is called with (host_id_t, const remote_host_state&) as arguments. This function is subject to change without notice. Prefer using for_each_host.

◆ for_each_instance_node_state()

template<typename Function >
void eagine::msgbus::remote_node_tracker::for_each_instance_node_state ( process_instance_id_t  inst_id,
Function  func 
)

Calls a function on tracked remote bus nodes of an instance (process).

See also
remote_node_state
for_each_node_state
for_each_host_node_state

The function is called with (host_id_t, const remote_node_state&) as arguments. This function is subject to change without notice. Prefer using for_each_node.

◆ for_each_node()

template<typename Function >
void eagine::msgbus::remote_node_tracker::for_each_node ( Function  func)

Calls a function on each tracked remote bus node.

See also
remote_node
for_each_node_state
for_each_host

The function is called with (host_id_t, const remote_node&) as arguments.

◆ for_each_node_state()

template<typename Function >
void eagine::msgbus::remote_node_tracker::for_each_node_state ( Function  func)

Calls a function on each tracked remote bus node.

See also
remote_node_state
for_each_node
for_each_host

The function is called with (host_id_t, const remote_node_state&) as arguments. This function is subject to change without notice. Prefer using for_each_node.

◆ get_connection() [1/2]

auto eagine::msgbus::remote_node_tracker::get_connection ( identifier_t  node_id1,
identifier_t  node_id2 
) -> node_connection_state &

Finds and returns the information about remote node connections.

See also
get_node
get_host
get_instance
for_each_connection

◆ get_connection() [2/2]

auto eagine::msgbus::remote_node_tracker::get_connection ( identifier_t  node_id1,
identifier_t  node_id2 
) const -> node_connection_state

Finds and returns the information about remote node connections.

See also
get_node
get_host
get_instance
for_each_connection

◆ get_host() [1/2]

auto eagine::msgbus::remote_node_tracker::get_host ( host_id_t  ) -> remote_host_state &

Finds and returns the state information about a remote host.

See also
get_node
get_instance
get_connection
for_each_host

◆ get_host() [2/2]

auto eagine::msgbus::remote_node_tracker::get_host ( host_id_t  ) const -> remote_host_state

Finds and returns the state information about a remote host.

See also
get_node
get_instance
get_connection
for_each_host

◆ get_instance() [1/2]

auto eagine::msgbus::remote_node_tracker::get_instance ( host_id_t  ) -> remote_instance_state &

Finds and returns the information about a remote instance (process).

See also
get_node
get_host
get_connection

◆ get_instance() [2/2]

auto eagine::msgbus::remote_node_tracker::get_instance ( host_id_t  ) const -> remote_instance_state

Finds and returns the information about a remote instance (process).

See also
get_node
get_host
get_connection

◆ get_node()

auto eagine::msgbus::remote_node_tracker::get_node ( identifier_t  node_id) -> remote_node_state &

Finds and returns the state information about a remote bus node.

See also
get_host
get_instance
get_connection
for_each_node

The documentation for this class was generated from the following file:

Copyright © 2015-2021 Matúš Chochlík.
<chochlik -at -gmail.com>
Documentation generated on Tue Apr 13 2021 by Doxygen (version 1.8.17).