Field-model receive base class shared by every transport-specific getter. More...

#include <getter_impl.h>

Inheritance diagram for vlink::GetterImpl:

Collaboration diagram for vlink::GetterImpl:

Public Member Functions
	~GetterImpl () override
	Releases backend resources. More...

virtual bool	listen (MsgCallback &&callback)=0
	Installs the latest-value notification callback. More...

virtual void	set_latency_and_lost_enabled (bool enable)
	Enables or disables per-update latency and loss tracking. More...

virtual bool	is_latency_and_lost_enabled () const
	Reports whether tracking is currently enabled. More...

virtual int64_t	get_latency () const
	Returns the most recent end-to-end latency measurement in nanoseconds. More...

virtual SampleLostInfo	get_lost () const
	Returns cumulative delivered / lost counts for field updates. 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 void	interrupt ()
	Marks the node interrupted and wakes blocking operations. 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_listened {false}
	`true` once `listen()` has been registered successfully. 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
	GetterImpl ()
	Stamps the node as `kGetter`. 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

Field-model receive base class shared by every transport-specific getter.

Provides safe defaults for the optional latency / loss instrumentation so that backends without those signals can be plugged in without supplying empty overrides. Concrete backends override listen() to wire the transport receive path to the supplied MsgCallback.

Constructor & Destructor Documentation

◆ ~GetterImpl()

vlink::GetterImpl::~GetterImpl ( )

override

Releases backend resources.

◆ GetterImpl()

vlink::GetterImpl::GetterImpl ( )

protected

Stamps the node as kGetter.

Member Function Documentation

◆ get_latency()

virtual int64_t vlink::GetterImpl::get_latency ( ) const

virtual

Returns the most recent end-to-end latency measurement in nanoseconds.

Only meaningful when is_latency_and_lost_enabled() returns true.

Returns: Latency in nanoseconds; 0 if tracking is disabled or unsupported.

◆ get_lost()

virtual SampleLostInfo vlink::GetterImpl::get_lost ( ) const

virtual

Returns cumulative delivered / lost counts for field updates.

Returns: SampleLostInfo with total and lost counters.

◆ is_latency_and_lost_enabled()

virtual bool vlink::GetterImpl::is_latency_and_lost_enabled ( ) const

virtual

Reports whether tracking is currently enabled.

Returns: true when the backend is collecting latency / loss data.

◆ listen()

virtual bool vlink::GetterImpl::listen ( MsgCallback && callback )

pure virtual

Installs the latest-value notification callback.

Pure virtual. Backends bind callback to the transport receive path so the public Getter sees every value written by the matching Setter. The owning Getter sets is_listened to true once this method succeeds.

Parameters

callback Callable void(const Bytes&) invoked on each update.

Returns: true on successful registration; false on error.

◆ set_latency_and_lost_enabled()

virtual void vlink::GetterImpl::set_latency_and_lost_enabled ( bool enable )

virtual

Enables or disables per-update latency and loss tracking.

Default no-op. Backends that maintain timestamps and sequence numbers override the method to activate the instrumentation.

Parameters

enable true to start tracking; false to stop.

Member Data Documentation

◆ is_listened

bool vlink::GetterImpl::is_listened {false}

true once listen() has been registered successfully.

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

include/vlink/impl/getter_impl.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~GetterImpl()

◆ GetterImpl()

Member Function Documentation

◆ get_latency()

◆ get_lost()

◆ is_latency_and_lost_enabled()

◆ listen()

◆ set_latency_and_lost_enabled()

Member Data Documentation

◆ is_listened