Event-model receive base shared by every transport-specific subscriber. 更多...

#include <subscriber_impl.h>

类 vlink::SubscriberImpl 继承关系图:

vlink::SubscriberImpl 的协作图:

Public 成员函数
	~SubscriberImpl () override
	Releases backend resources. 更多...

virtual bool	listen (MsgCallback &&callback)=0
	Installs the serialised-message receive callback. 更多...

virtual bool	listen (IntraMsgCallback &&callback)
	Installs the zero-copy in-process receive callback. 更多...

virtual void	set_latency_and_lost_enabled (bool enable)
	Enables or disables per-message latency / loss tracking. 更多...

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

virtual int64_t	get_latency () const
	Returns the most recently measured end-to-end latency in nanoseconds. 更多...

virtual SampleLostInfo	get_lost () const
	Returns cumulative delivered / lost counters. 更多...

Public 成员函数继承自 vlink::NodeImpl
virtual void	init ()=0
	Brings the underlying transport channel online. 更多...

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

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

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

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

virtual void	interrupt ()
	Marks the node interrupted and wakes blocking operations. 更多...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public 属性
bool	is_listened {false}
	`true` once `listen()` has been registered successfully. 更多...

Public 属性继承自 vlink::NodeImpl
std::string	url
	Full URL string of the node, e.g. `"dds://my/topic"`. 更多...

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

ImplType	impl_type {kUnknownImplType}
	Role of this implementation node. 更多...

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

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

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

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

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

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

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

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

Protected 成员函数
	SubscriberImpl ()
	Stamps the node as `kSubscriber`. 更多...

Protected 成员函数继承自 vlink::NodeImpl
	NodeImpl (ImplType type)

virtual	~NodeImpl ()

额外继承的成员函数
Public 类型继承自 vlink::NodeImpl
using	ConnectCallback = Function< void(bool)>
	Callback fired when peer presence changes. 更多...

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

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

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

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

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

静态 Public 成员函数继承自 vlink::NodeImpl
static void	global_init ()
	Initialises process-wide VLink singletons. 更多...

详细描述

Event-model receive base shared by every transport-specific subscriber.

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

构造及析构函数说明

◆ ~SubscriberImpl()

vlink::SubscriberImpl::~SubscriberImpl ( )

override

Releases backend resources.

◆ SubscriberImpl()

vlink::SubscriberImpl::SubscriberImpl ( )

protected

Stamps the node as kSubscriber.

成员函数说明

◆ get_latency()

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

virtual

Returns the most recently measured end-to-end latency in nanoseconds.

Only meaningful when is_latency_and_lost_enabled() returns true.

返回: Latency in nanoseconds; 0 when tracking is off or unsupported.

◆ get_lost()

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

virtual

Returns cumulative delivered / lost counters.

Only meaningful when tracking is enabled. Default returns a zero-initialised SampleLostInfo.

返回: SampleLostInfo with total and lost counts.

◆ is_latency_and_lost_enabled()

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

virtual

Reports whether tracking is currently enabled.

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

◆ listen() [1/2]

virtual bool vlink::SubscriberImpl::listen ( IntraMsgCallback && callback )

virtual

Installs the zero-copy in-process receive callback.

Only the intra:// backend overrides this overload; the default logs a warning and returns false.

参数

callback Callable void(const IntraData&) invoked for each in-process delivery.

返回: true when registration succeeded; false when the transport does not support IntraData.

◆ listen() [2/2]

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

pure virtual

Installs the serialised-message receive callback.

Pure virtual. Backends invoke callback with the raw payload bytes for each frame received. The public Subscriber sets is_listened to true on success.

参数

callback Callable void(const Bytes&) invoked on every received frame.

返回: true when registration succeeded; false on error.

◆ set_latency_and_lost_enabled()

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

virtual

Enables or disables per-message latency / loss tracking.

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

参数

enable true to enable; false to disable.

类成员变量说明

◆ is_listened

bool vlink::SubscriberImpl::is_listened {false}

true once listen() has been registered successfully.

该类的文档由以下文件生成:

include/vlink/impl/subscriber_impl.h

Public 成员函数

Public 属性

Protected 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~SubscriberImpl()

◆ SubscriberImpl()

成员函数说明

◆ get_latency()

◆ get_lost()

◆ is_latency_and_lost_enabled()

◆ listen() [1/2]

◆ listen() [2/2]

◆ set_latency_and_lost_enabled()

类成员变量说明

◆ is_listened