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

eagine::msgbus::subscriber_base Class Reference

Base class for message bus subscribers. More...

#include <eagine/message_bus/subscriber.hpp>

Public Member Functions

 operator bool () noexcept
 Tests if this subscribes has an associated endpoint and is usable.
 
auto bus () noexcept -> auto &
 Returns a reference to the associated endpoint. More...
 
auto bus () const noexcept -> auto &
 Returns a const reference to the associated endpoint. More...
 
auto update () const noexcept -> bool
 Updates the internal endpoint state (should be called repeatedly).
 
auto verify_bits (const stored_message &message) noexcept -> verification_bits
 Uses the associated endpoint to verify the specified message.
 
void query_subscriptions_of (identifier_t target_id)
 Queries the subscriptions of the remote endpoint with the specified id. More...
 
void query_subscribers_of (message_id sub_msg)
 Queries remote nodes subscribing to the specified message. More...
 
 subscriber_base (const subscriber_base &)=delete
 Not copy assignable.
 
auto operator= (subscriber_base &&)=delete
 Not move assignable.
 
auto operator= (const subscriber_base &)=delete
 Not copy constructible.
 

Detailed Description

Base class for message bus subscribers.

See also
static_subscriber
subscriber
endpoint

Member Function Documentation

◆ bus() [1/2]

auto eagine::msgbus::subscriber_base::bus ( ) const -> auto&
inlinenoexcept

Returns a const reference to the associated endpoint.

Precondition
bool(*this)

◆ bus() [2/2]

auto eagine::msgbus::subscriber_base::bus ( ) -> auto&
inlinenoexcept

◆ query_subscribers_of()

void eagine::msgbus::subscriber_base::query_subscribers_of ( message_id  sub_msg)
inline

Queries remote nodes subscribing to the specified message.

See also
query_subscriptions_of

◆ query_subscriptions_of()

void eagine::msgbus::subscriber_base::query_subscriptions_of ( identifier_t  target_id)
inline

Queries the subscriptions of the remote endpoint with the specified id.

See also
query_subscribers_of

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