Per-topic registry of NodeImpl instances and their associated callbacks. More...

#include <abstract_factory.h>

Inheritance diagram for vlink::AbstractObject< FilterT >:

Collaboration diagram for vlink::AbstractObject< FilterT >:

Public Types
using	ImplList = std::unordered_set<NodeImpl*>
	Set of registered impl pointers.
using	ConnectCallbackMap = std::unordered_map<NodeImpl*, NodeImpl::ConnectCallback>
	Per-impl connect callbacks.
using	ReqRespCallbackMap
	Per-impl req/resp callbacks.
using	MsgCallbackMap = std::unordered_map<NodeImpl*, NodeImpl::MsgCallback>
	Per-impl message callbacks.
using	IntraMsgCallbackMap
	Per-impl intra-msg callbacks.
using	StatusCallbackMap = std::unordered_map<NodeImpl*, NodeImpl::StatusCallback>
	Per-impl status callbacks.
using	FindConnectCallback
	Traversal visitor for connect callbacks.
using	FindReqRespCallback
	Traversal visitor for req/resp callbacks.
using	FindMsgCallback
	Traversal visitor for message callbacks.
using	FindIntraMsgCallback
	Traversal visitor for intra-msg callbacks.
using	FindStatusCallback
	Traversal visitor for status callbacks.

Public Member Functions
bool	add_impl (NodeImpl *impl)
	Registers a `NodeImpl` instance with this topic object.
bool	remove_impl (NodeImpl *impl)
	Unregisters a `NodeImpl` instance and removes all its callbacks.
NodeImpl *	get_first_impl () const
	Returns the most recently added `NodeImpl` pointer.
bool	is_contains_impl (NodeImpl *impl) const
	Returns `true` if `impl` is currently registered with this object.
bool	has_impl () const
	Returns `true` if at least one `NodeImpl` is currently registered.
bool	register_server_connect_callback (NodeImpl *impl, NodeImpl::ConnectCallback &&callback)
	Registers a server-side connect-change callback for `impl`.
bool	register_sub_connect_callback (NodeImpl *impl, NodeImpl::ConnectCallback &&callback)
	Registers a subscriber-side connect-change callback for `impl`.
bool	register_req_resp_callback (NodeImpl *impl, NodeImpl::ReqRespCallback &&callback)
	Registers a request/response callback for `impl`.
bool	register_msg_callback (NodeImpl *impl, NodeImpl::MsgCallback &&callback)
	Registers a serialised-message receive callback for `impl`.
bool	register_intra_msg_callback (NodeImpl *impl, NodeImpl::IntraMsgCallback &&callback)
	Registers an in-process zero-copy message callback for `impl`.
bool	register_status_callback (NodeImpl *impl, NodeImpl::StatusCallback &&callback)
	Registers a transport-status callback for `impl`.
bool	server_connect_map_is_empty () const
	Returns `true` if no server-connect callbacks are registered.
bool	sub_connect_map_is_empty () const
	Returns `true` if no subscriber-connect callbacks are registered.
bool	req_resp_map_is_empty () const
	Returns `true` if no request/response callbacks are registered.
bool	msg_map_is_empty () const
	Returns `true` if no message callbacks are registered.
bool	status_map_is_empty () const
	Returns `true` if no status callbacks are registered.
void	traverse_server_connect_callback (const FindConnectCallback &callback)
	Invokes `callback` for each registered server-connect callback.
void	traverse_sub_connect_callback (const FindConnectCallback &callback)
	Invokes `callback` for each registered subscriber-connect callback.
void	traverse_req_resp_callback (const FindReqRespCallback &callback)
	Invokes `callback` for each registered request/response callback.
void	traverse_msg_callback (const FindMsgCallback &callback)
	Invokes `callback` for each registered serialised-message callback.
void	traverse_intra_msg_callback (const FindIntraMsgCallback &callback)
	Invokes `callback` for each registered in-process message callback.
void	traverse_status_callback (const FindStatusCallback &callback)
	Invokes `callback` for each registered status callback.
Public Member Functions inherited from vlink::AbstractNode
virtual std::any	get_native_handle () const
	Returns the underlying native transport handle wrapped in `std::any`.

Protected Member Functions
	AbstractObject ()
	~AbstractObject () override
bool	has_called () const
void	ignore_called ()
Protected Member Functions inherited from vlink::AbstractNode
	AbstractNode ()
virtual	~AbstractNode ()

Detailed Description

template<typename FilterT>
class vlink::AbstractObject< FilterT >

Per-topic registry of NodeImpl instances and their associated callbacks.

Maintains an unordered set of active NodeImpl* pointers and six separate callback maps (server-connect, subscriber-connect, req/resp, msg, intra-msg, status). All mutations and traversals are protected by a std::recursive_mutex to allow safe use from multiple threads.

Template Parameters

FilterT Key type used by the owning AbstractFactory to look up this object (typically a topic URL string).

Member Typedef Documentation

◆ ConnectCallbackMap

template<typename FilterT>

using vlink::AbstractObject< FilterT >::ConnectCallbackMap = std::unordered_map<NodeImpl*, NodeImpl::ConnectCallback>

Per-impl connect callbacks.

◆ FindConnectCallback

template<typename FilterT>

using vlink::AbstractObject< FilterT >::FindConnectCallback

Initial value:

std::function<void(NodeImpl*, const NodeImpl::ConnectCallback&)>

vlink::NodeImpl

Abstract base for all VLink transport backend node implementations.

Definition node_impl.h:141

vlink::NodeImpl::ConnectCallback

std::function< void(bool)> ConnectCallback

Callback invoked when the peer connection state changes.

Definition node_impl.h:148

Traversal visitor for connect callbacks.

◆ FindIntraMsgCallback

template<typename FilterT>

using vlink::AbstractObject< FilterT >::FindIntraMsgCallback

Initial value:

std::function<void(

NodeImpl*, const NodeImpl::IntraMsgCallback&)>

vlink::NodeImpl::IntraMsgCallback

std::function< void(const IntraData &)> IntraMsgCallback

Callback delivering an in-process IntraData message.

Definition node_impl.h:186

Traversal visitor for intra-msg callbacks.

◆ FindMsgCallback

template<typename FilterT>

using vlink::AbstractObject< FilterT >::FindMsgCallback

Initial value:

std::function<void(NodeImpl*, const NodeImpl::MsgCallback&)>

vlink::NodeImpl::MsgCallback

std::function< void(const Bytes &)> MsgCallback

Callback delivering a raw serialised message to a SubscriberImpl or GetterImpl.

Definition node_impl.h:177

Traversal visitor for message callbacks.

◆ FindReqRespCallback

template<typename FilterT>

using vlink::AbstractObject< FilterT >::FindReqRespCallback

Initial value:

std::function<void(NodeImpl*, const NodeImpl::ReqRespCallback&)>

vlink::NodeImpl::ReqRespCallback

std::function< void(uint64_t, const Bytes &, Bytes *)> ReqRespCallback

Callback for ServerImpl request/response processing.

Definition node_impl.h:170

Traversal visitor for req/resp callbacks.

◆ FindStatusCallback

template<typename FilterT>

using vlink::AbstractObject< FilterT >::FindStatusCallback

Initial value:

std::function<void(NodeImpl*, const NodeImpl::StatusCallback&)>

vlink::NodeImpl::StatusCallback

std::function< void(const Status::BasePtr &ptr)> StatusCallback

Callback invoked on DDS status events (e.g. deadline missed).

Definition node_impl.h:155

Traversal visitor for status callbacks.

◆ ImplList

template<typename FilterT>

using vlink::AbstractObject< FilterT >::ImplList = std::unordered_set<NodeImpl*>

Set of registered impl pointers.

◆ IntraMsgCallbackMap

template<typename FilterT>

using vlink::AbstractObject< FilterT >::IntraMsgCallbackMap

Initial value:

std::unordered_map<NodeImpl*, NodeImpl::IntraMsgCallback>

Per-impl intra-msg callbacks.

◆ MsgCallbackMap

template<typename FilterT>

using vlink::AbstractObject< FilterT >::MsgCallbackMap = std::unordered_map<NodeImpl*, NodeImpl::MsgCallback>

Per-impl message callbacks.

◆ ReqRespCallbackMap

template<typename FilterT>

using vlink::AbstractObject< FilterT >::ReqRespCallbackMap

Initial value:

std::unordered_map<NodeImpl*, NodeImpl::ReqRespCallback>

Per-impl req/resp callbacks.

◆ StatusCallbackMap

template<typename FilterT>

using vlink::AbstractObject< FilterT >::StatusCallbackMap = std::unordered_map<NodeImpl*, NodeImpl::StatusCallback>

Per-impl status callbacks.

Constructor & Destructor Documentation

◆ AbstractObject()

template<typename FilterT>

vlink::AbstractObject< FilterT >::AbstractObject ( )

inlineprotecteddefault

◆ ~AbstractObject()

template<typename FilterT>

vlink::AbstractObject< FilterT >::~AbstractObject ( )

inlineoverrideprotecteddefault

Member Function Documentation

◆ add_impl()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::add_impl ( NodeImpl * impl )

inline

Registers a NodeImpl instance with this topic object.

Details.

Inserts impl into the active implementation set and updates the cached first_impl_ pointer. Thread-safe.

Parameters

impl	Non-owning pointer to the `NodeImpl` to register.

Returns: true if impl was newly inserted; false if it was already present.

◆ get_first_impl()

template<typename FilterT>

NodeImpl * vlink::AbstractObject< FilterT >::get_first_impl ( ) const

nodiscard

Returns the most recently added NodeImpl pointer.

The "first" impl is set to the last value passed to add_impl(). If the current first impl is removed via remove_impl(), it is reassigned to an arbitrary remaining impl, or nullptr if the set is empty.

Returns: Pointer to the most recently registered NodeImpl, or nullptr.

◆ has_called()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::has_called ( ) const

inlinenodiscardprotected

◆ has_impl()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::has_impl ( ) const

inlinenodiscard

Returns true if at least one NodeImpl is currently registered.

Returns: true if the active implementation set is non-empty.

◆ ignore_called()

template<typename FilterT>

void vlink::AbstractObject< FilterT >::ignore_called ( )

inlineprotected

◆ is_contains_impl()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::is_contains_impl ( NodeImpl * impl ) const

inlinenodiscard

Returns true if impl is currently registered with this object.

Parameters

impl	Pointer to check.

Returns: true if impl is in the active set; false otherwise.

◆ msg_map_is_empty()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::msg_map_is_empty ( ) const

inlinenodiscard

Returns true if no message callbacks are registered.

Returns: true when the message callback map is empty.

◆ register_intra_msg_callback()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::register_intra_msg_callback	(	NodeImpl *	impl,
		NodeImpl::IntraMsgCallback &&	callback )

inline

Registers an in-process zero-copy message callback for impl.

Parameters

impl	The `NodeImpl` this callback belongs to.
callback	Callable `void(const IntraData&)` invoked on each intra message.

Returns: true if inserted; false if already registered.

◆ register_msg_callback()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::register_msg_callback	(	NodeImpl *	impl,
		NodeImpl::MsgCallback &&	callback )

inline

Registers a serialised-message receive callback for impl.

Parameters

impl	The `NodeImpl` this callback belongs to.
callback	Callable `void(const Bytes&)` invoked on each message.

Returns: true if inserted; false if already registered.

◆ register_req_resp_callback()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::register_req_resp_callback	(	NodeImpl *	impl,
		NodeImpl::ReqRespCallback &&	callback )

inline

Registers a request/response callback for impl.

Parameters

impl	The `NodeImpl` this callback belongs to.
callback	Callable invoked for each incoming RPC request.

Returns: true if inserted; false if already registered.

◆ register_server_connect_callback()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::register_server_connect_callback	(	NodeImpl *	impl,
		NodeImpl::ConnectCallback &&	callback )

inline

Registers a server-side connect-change callback for impl.

Stores the callback in the server-connect map keyed by impl. A subsequent call to traverse_server_connect_callback() will invoke this callback.

Parameters

impl	The `NodeImpl` this callback belongs to.
callback	Callable `void(bool)` invoked on client-presence changes.

Returns: true if the callback was inserted; false if one was already registered for impl.

◆ register_status_callback()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::register_status_callback	(	NodeImpl *	impl,
		NodeImpl::StatusCallback &&	callback )

inline

Registers a transport-status callback for impl.

Parameters

impl	The `NodeImpl` this callback belongs to.
callback	Callable invoked on transport status changes.

Returns: true if inserted; false if already registered.

◆ register_sub_connect_callback()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::register_sub_connect_callback	(	NodeImpl *	impl,
		NodeImpl::ConnectCallback &&	callback )

inline

Registers a subscriber-side connect-change callback for impl.

Stores the callback in the subscriber-connect map keyed by impl.

Parameters

impl	The `NodeImpl` this callback belongs to.
callback	Callable `void(bool)` invoked on subscriber-presence changes.

Returns: true if the callback was inserted; false if already set.

◆ remove_impl()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::remove_impl ( NodeImpl * impl )

inline

Unregisters a NodeImpl instance and removes all its callbacks.

Erases impl from the active set and removes its entries from all six callback maps. Thread-safe.

Parameters

impl	Non-owning pointer to the `NodeImpl` to unregister.

Returns: true if impl was found and removed; false otherwise.

◆ req_resp_map_is_empty()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::req_resp_map_is_empty ( ) const

inlinenodiscard

Returns true if no request/response callbacks are registered.

Returns: true when the req/resp callback map is empty.

◆ server_connect_map_is_empty()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::server_connect_map_is_empty ( ) const

inlinenodiscard

Returns true if no server-connect callbacks are registered.

Returns: true when the server-connect callback map is empty.

◆ status_map_is_empty()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::status_map_is_empty ( ) const

inlinenodiscard

Returns true if no status callbacks are registered.

Returns: true when the status callback map is empty.

◆ sub_connect_map_is_empty()

template<typename FilterT>

bool vlink::AbstractObject< FilterT >::sub_connect_map_is_empty ( ) const

inlinenodiscard

Returns true if no subscriber-connect callbacks are registered.

Returns: true when the subscriber-connect callback map is empty.

◆ traverse_intra_msg_callback()

template<typename FilterT>

void vlink::AbstractObject< FilterT >::traverse_intra_msg_callback ( const FindIntraMsgCallback & callback )

inline

Invokes callback for each registered in-process message callback.

Parameters

callback Visitor called for each intra-msg entry.

◆ traverse_msg_callback()

template<typename FilterT>

void vlink::AbstractObject< FilterT >::traverse_msg_callback ( const FindMsgCallback & callback )

inline

Invokes callback for each registered serialised-message callback.

Parameters

callback Visitor called for each message callback entry.

◆ traverse_req_resp_callback()

template<typename FilterT>

void vlink::AbstractObject< FilterT >::traverse_req_resp_callback ( const FindReqRespCallback & callback )

inline

Invokes callback for each registered request/response callback.

Parameters

callback Visitor called for each req/resp entry.

◆ traverse_server_connect_callback()

template<typename FilterT>

void vlink::AbstractObject< FilterT >::traverse_server_connect_callback ( const FindConnectCallback & callback )

inline

Invokes callback for each registered server-connect callback.

Iterates over all entries in the server-connect map while holding the mutex. The visitor receives the NodeImpl* and the stored ConnectCallback. Iteration can be short-circuited by calling ignore_called() inside the visitor.

Parameters

callback Visitor called as callback(impl, stored_callback) for each entry.

◆ traverse_status_callback()

template<typename FilterT>

void vlink::AbstractObject< FilterT >::traverse_status_callback ( const FindStatusCallback & callback )

inline

Invokes callback for each registered status callback.

Parameters

callback Visitor called for each status entry.

◆ traverse_sub_connect_callback()

template<typename FilterT>

void vlink::AbstractObject< FilterT >::traverse_sub_connect_callback ( const FindConnectCallback & callback )

inline

Invokes callback for each registered subscriber-connect callback.

Parameters

callback Visitor called for each subscriber-connect entry.

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

include/vlink/impl/abstract_factory.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConnectCallbackMap

◆ FindConnectCallback

◆ FindIntraMsgCallback

◆ FindMsgCallback

◆ FindReqRespCallback

◆ FindStatusCallback

◆ ImplList

◆ IntraMsgCallbackMap

◆ MsgCallbackMap

◆ ReqRespCallbackMap

◆ StatusCallbackMap

Constructor & Destructor Documentation

◆ AbstractObject()

◆ ~AbstractObject()

Member Function Documentation

◆ add_impl()

◆ get_first_impl()

◆ has_called()

◆ has_impl()

◆ ignore_called()

◆ is_contains_impl()

◆ msg_map_is_empty()

◆ register_intra_msg_callback()

◆ register_msg_callback()

◆ register_req_resp_callback()

◆ register_server_connect_callback()

◆ register_status_callback()

◆ register_sub_connect_callback()

◆ remove_impl()

◆ req_resp_map_is_empty()

◆ server_connect_map_is_empty()

◆ status_map_is_empty()

◆ sub_connect_map_is_empty()

◆ traverse_intra_msg_callback()

◆ traverse_msg_callback()

◆ traverse_req_resp_callback()

◆ traverse_server_connect_callback()

◆ traverse_status_callback()

◆ traverse_sub_connect_callback()