Connection-aware base class for method-model client implementations. More...

#include <client_impl.h>

Inheritance diagram for vlink::ClientImpl:

Collaboration diagram for vlink::ClientImpl:

Public Member Functions
	~ClientImpl () override
	Releases the helper state held by the base class. More...

void	interrupt () override
	Wakes blocked waiters and forwards the interrupt to `NodeImpl`. More...

virtual void	detect_connected (ConnectCallback &&callback)
	Registers `callback` to fire whenever the server presence changes. More...

virtual bool	wait_for_connected (std::chrono::milliseconds timeout)
	Blocks until a server becomes reachable or `timeout` elapses. More...

virtual bool	is_connected () const =0
	Reports whether the transport currently holds a path to a server. More...

virtual bool	call (const Bytes &req_data, MsgCallback &&callback, std::chrono::milliseconds timeout)=0
	Performs a synchronous round-trip with the remote server. More...

void	update_connected ()
	Notifies the base class that the underlying connection state may have changed. More...

Public Member Functions inherited from vlink::NodeImpl
virtual void	init ()=0
	Brings the underlying transport channel online. More...

virtual void	deinit ()=0
	Tears the underlying transport channel down. More...

virtual bool	suspend ()
	Pauses message delivery without releasing the channel. More...

virtual bool	resume ()
	Resumes message delivery after `suspend()`. More...

virtual bool	is_suspend () const
	Reports whether the node is currently suspended. More...

virtual bool	is_support_loan () const
	Indicates whether zero-copy loaning is available on this backend. More...

virtual Bytes	loan (int64_t size)
	Borrows a write buffer of `size` bytes from the transport. More...

virtual bool	return_loan (const Bytes &bytes)
	Returns a previously loaned buffer to the transport. More...

virtual void	set_manual_unloan (bool manual_unloan)
	Toggles automatic versus manual release of received loaned buffers. More...

virtual const struct Conf *	get_conf () const
	Returns the associated transport `Conf`, or `nullptr` in the base. More...

virtual const AbstractNode *	get_abstract_node () const
	Returns the companion `AbstractNode`, when the impl is split. More...

virtual Status::BasePtr	get_status (Status::Type type) const
	Retrieves a transport-specific status object. More...

virtual bool	check_version (const Version &version)
	Compares `version` with the runtime VLink library version. More...

virtual bool	attach (class MessageLoop *message_loop)
	Attaches the node to a `MessageLoop` for callback dispatch. More...

virtual bool	detach ()
	Detaches the node from its `MessageLoop`. More...

class MessageLoop *	get_message_loop () const
	Returns the currently attached `MessageLoop`. More...

template<typename T >
const T *	get_target_conf () const
	Convenience downcast wrapper around `get_conf()`. More...

void	register_status_handler (StatusCallback &&callback)
	Installs a DDS-family status handler. More...

bool	has_register_status () const
	Reports whether a status handler has been registered. More...

void	call_status (Status::BasePtr ptr)
	Delivers a status notification to the registered handler. More...

void	set_property (const std::string &prop, const std::string &value)
	Sets a named property on this node. More...

std::string	get_property (const std::string &prop) const
	Retrieves the value of a named property. More...

Conf::PropertiesMap	get_all_properties () const
	Returns a copy of every property currently set on this node. More...

void	set_discovery_enabled (bool enable)
	Toggles whether this node is reported to the discovery layer. More...

bool	get_discovery_enabled () const
	Returns the current discovery-reporting flag. More...

void	set_record_path (const std::string &path)
	Configures per-node message recording. More...

bool	enable_security (const Security::Config &cfg)
	Installs application-layer security from a const-reference config. More...

bool	enable_security (Security::Config &&cfg)
	Installs application-layer security by consuming `cfg`. More...

void	set_ssl_options (const SslOptions &options)
	Merges SSL options into the node property map. More...

void	try_record (ActionType action_type, const Bytes &data)
	Records a message to the global and / or per-node bag writers. More...

void	reset_interrupted ()
	Clears the interrupted flag set by `interrupt()`. More...

bool	is_interrupted () const
	Reports whether `interrupt()` has been called and not yet reset. More...

void	init_ext ()
	Registers the node with the runtime-owned discovery reporter. More...

void	deinit_ext ()
	Deregisters the node from the runtime-owned discovery reporter. More...

Public Attributes
bool	is_resp_type {false}
	`true` when the public `Client` expects a response payload. More...

Public Attributes inherited from vlink::NodeImpl
std::string	url
	Full URL string of the node, e.g. `"dds://my/topic"`. More...

std::string	ser_type
	Concrete serialisation type tag (e.g. `"demo.proto.PointCloud"`). More...

ImplType	impl_type {kUnknownImplType}
	Role of this implementation node. More...

SchemaType	schema_type {SchemaType::kUnknown}
	Coarse schema family reported to discovery and bag / proxy paths. More...

TransportType	transport_type {TransportType::kUnknown}
	Transport backend identifier for this node. More...

bool	is_cdr_type {false}
	`true` when DDS native CDR serialisation is in use. More...

bool	is_security_type {false}
	`true` when an authenticated transport is enabled. More...

bool	is_discovery_enabled {true}
	Whether the node is reported to the discovery layer. More...

std::atomic_bool	has_suspend {false}
	Atomic suspend flag (currently unused by the default impls). More...

std::unique_ptr< CpuProfiler >	profiler
	Optional per-node CPU profiler activated under global profiling. More...

std::unique_ptr< Security >	security
	Installed per-node message-security context, or `nullptr`. More...

Protected Member Functions
	ClientImpl ()
	Stamps the node as `kClient` and prepares the helper state. More...

Protected Member Functions inherited from vlink::NodeImpl
	NodeImpl (ImplType type)

virtual	~NodeImpl ()

Additional Inherited Members
Public Types inherited from vlink::NodeImpl
using	ConnectCallback = Function< void(bool)>
	Callback fired when peer presence changes. More...

using	StatusCallback = Function< void(const Status::BasePtr &ptr)>
	Callback fired on DDS-family status notifications (e.g. deadline missed). More...

using	SyncCallback = Function< void()>
	Callback fired when a `SetterImpl` completes a late-getter sync. More...

using	ReqRespCallback = Function< void(uint64_t, const Bytes &, Bytes *)>
	Request / response handler installed by `ServerImpl::listen()`. More...

using	MsgCallback = Function< void(const Bytes &)>
	Callback delivering a serialised payload to a subscriber or getter. More...

using	IntraMsgCallback = Function< void(const IntraData &)>
	Callback delivering an in-process payload to an intra:// subscriber. More...

Static Public Member Functions inherited from vlink::NodeImpl
static void	global_init ()
	Initialises process-wide VLink singletons. More...

Detailed Description

Connection-aware base class for method-model client implementations.

Owns the helper condition variable used by wait_for_connected() and the cached ConnectCallback delivered via detect_connected(). Backends are expected to push presence updates by calling update_connected() whenever the discovery layer reports a server appear / disappear event.

Constructor & Destructor Documentation

◆ ~ClientImpl()

vlink::ClientImpl::~ClientImpl ( )

override

Releases the helper state held by the base class.

◆ ClientImpl()

vlink::ClientImpl::ClientImpl ( )

protected

Stamps the node as kClient and prepares the helper state.

Member Function Documentation

◆ call()

virtual bool vlink::ClientImpl::call	(	const Bytes &	req_data,
		MsgCallback &&	callback,
		std::chrono::milliseconds	timeout
	)

pure virtual

Performs a synchronous round-trip with the remote server.

Pure virtual; subclasses send req_data, wait for the matching response (typically through AckManager) and invoke callback with the received bytes once a frame arrives.

Parameters

req_data	Serialised request payload.
callback	Callable `void(const Bytes&)` receiving the response bytes.
timeout	Maximum wait duration; negative for unlimited.

Returns: true on success; false on timeout, interruption or transport error.

◆ detect_connected()

virtual void vlink::ClientImpl::detect_connected ( ConnectCallback && callback )

virtual

Registers callback to fire whenever the server presence changes.

If the connection is already established at registration time, callback is invoked with true before this method returns. Subsequent transitions are forwarded by update_connected().

Parameters

callback Callable void(bool) to be notified on connect / disconnect.

◆ interrupt()

void vlink::ClientImpl::interrupt ( )

overridevirtual

Wakes blocked waiters and forwards the interrupt to NodeImpl.

Marks the node interrupted, notifies the helper condition variable so any wait_for_connected() call returns false promptly, and delegates the rest of the shutdown handshake to NodeImpl::interrupt(). Transport subclasses commonly override this to also cancel pending AckManager requests.

Reimplemented from vlink::NodeImpl.

◆ is_connected()

virtual bool vlink::ClientImpl::is_connected ( ) const

pure virtual

Reports whether the transport currently holds a path to a server.

Pure virtual; subclasses query their underlying discovery handle. Called by both wait_for_connected() and update_connected() to compute state transitions.

Returns: true when a server is reachable; false otherwise.

◆ update_connected()

void vlink::ClientImpl::update_connected ( )

Notifies the base class that the underlying connection state may have changed.

Compares is_connected() against the helper cache; when the value flips the condition variable is signalled and any registered ConnectCallback is delivered. Intended to run on the transport's discovery / listener thread, not on the application thread.

◆ wait_for_connected()

virtual bool vlink::ClientImpl::wait_for_connected ( std::chrono::milliseconds timeout )

virtual

Blocks until a server becomes reachable or timeout elapses.

Returns immediately when is_connected() already reports true. Otherwise sleeps on the helper condition variable that is poked by update_connected() and by interrupt(). A negative timeout, such as Timeout::kInfinite, disables the deadline.

Parameters

timeout Maximum sleep duration.

Returns: true when the server appeared in time; false on timeout or interruption.

Member Data Documentation

◆ is_resp_type

bool vlink::ClientImpl::is_resp_type {false}

true when the public Client expects a response payload.

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

include/vlink/impl/client_impl.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ClientImpl()

◆ ClientImpl()

Member Function Documentation

◆ call()

◆ detect_connected()

◆ interrupt()

◆ is_connected()

◆ update_connected()

◆ wait_for_connected()

Member Data Documentation

◆ is_resp_type