eagine::msgbus::remote_node Class Reference

Class providing information about a remote bus node. More...

#include <eagine/message_bus/remote_node.hpp>

Public Member Functions
	operator bool () const noexcept
	Indicates if this is not-empty and has actual information.
auto	id () const noexcept -> valid_if_not_zero< identifier_t >
	Returns the unique id of the remote bus node.
auto	instance_id () const noexcept -> valid_if_not_zero< process_instance_id_t >
	Returns the id of the instance in which the node is running.
auto	host_id () const noexcept -> valid_if_not_zero< host_id_t >
	Returns the id of the host on which the node is running.
auto	kind () const noexcept -> node_kind
	Returns the kind of the remote node. More...
auto	is_router_node () const noexcept -> tribool
	Returns if the remote node is a router control node. More...
auto	is_bridge_node () const noexcept -> tribool
	Returns if the remote node is a router control node. More...
auto	has_endpoint_info () const noexcept -> bool
	Indicates if endpoint information is available.
auto	app_name () const noexcept -> valid_if_not_empty< string_view >
	Returns the application name.
auto	display_name () const noexcept -> valid_if_not_empty< string_view >
	Returns the user-readable display name of the application.
auto	description () const noexcept -> valid_if_not_empty< string_view >
	Returns the user-readable description of the application.
auto	subscribes_to (message_id msg_id) const noexcept -> tribool
	Indicates if the remote node subscribes to the specified message type.
auto	is_pingable () const noexcept -> tribool
	Indicates if the remote node is pingable. More...
void	set_ping_interval (std::chrono::milliseconds) noexcept
	Sets the ping interval for the remote node. More...
auto	ping_success_rate () const noexcept -> valid_if_between_0_1< float >
	Returns the ping success rate for the remote node (0.0, 1.0). More...
auto	is_responsive () const noexcept -> tribool
	Indicates if the remote node is responsive. More...
auto	host () const noexcept -> remote_host
	Returns information about the host where the node is running. More...
auto	instance () const noexcept -> remote_instance
	Returns information about the instance in which the node is running. More...
auto	connections () const noexcept -> node_connections
	Return information about the connections of this node. More...

Detailed Description

Class providing information about a remote bus node.

See also

remote_node_tracker

remote_host

remote_instance

node_connection

Member Function Documentation

connections()

auto eagine::msgbus::remote_node::connections ( ) const -> node_connections

noexcept

Return information about the connections of this node.

See also

host

instance

host()

auto eagine::msgbus::remote_node::host ( ) const -> remote_host

noexcept

Returns information about the host where the node is running.

See also

instance

connections

instance()

auto eagine::msgbus::remote_node::instance ( ) const -> remote_instance

noexcept

Returns information about the instance in which the node is running.

See also

host

connections

is_bridge_node()

auto eagine::msgbus::remote_node::is_bridge_node ( ) const -> tribool

noexcept

Returns if the remote node is a router control node.

See also

is_bridge_node

kind

is_pingable()

auto eagine::msgbus::remote_node::is_pingable ( ) const -> tribool

noexcept

Indicates if the remote node is pingable.

See also

set_ping_interval

is_responsive

is_responsive()

auto eagine::msgbus::remote_node::is_responsive ( ) const -> tribool

noexcept

Indicates if the remote node is responsive.

See also

ping_success_rate

is_router_node()

auto eagine::msgbus::remote_node::is_router_node ( ) const -> tribool

noexcept

Returns if the remote node is a router control node.

See also

is_bridge_node

kind

kind()

auto eagine::msgbus::remote_node::kind ( ) const -> node_kind

noexcept

Returns the kind of the remote node.

See also

is_router_node

is_bridge_node

ping_success_rate()

auto eagine::msgbus::remote_node::ping_success_rate ( ) const -> valid_if_between_0_1< float >

noexcept

Returns the ping success rate for the remote node (0.0, 1.0).

See also

is_responsive

is_pingable

set_ping_interval()

void eagine::msgbus::remote_node::set_ping_interval ( std::chrono::milliseconds  )

noexcept

Sets the ping interval for the remote node.

See also

is_pingable

---

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

• eagine/message_bus/remote_node.hpp