Convenience alias of Subscriber with per-message decryption enabled. More...

#include <subscriber.h>

Inheritance diagram for vlink::SecuritySubscriber< MsgT >:

Collaboration diagram for vlink::SecuritySubscriber< MsgT >:

Public Types
using	UniquePtr = std::unique_ptr< SecuritySubscriber< MsgT > >
	Owning unique-pointer alias. More...

using	SharedPtr = std::shared_ptr< SecuritySubscriber< MsgT > >
	Owning shared-pointer alias. More...

Public Types inherited from vlink::Subscriber< MsgT, SecurityType::kWithSecurity >
using	UniquePtr = std::unique_ptr< Subscriber< MsgT, SecT > >
	Owning unique-pointer alias. More...

using	SharedPtr = std::shared_ptr< Subscriber< MsgT, SecT > >
	Owning shared-pointer alias. More...

using	MsgCallback = Function< void(const MsgT &)>
	User callback signature for received messages. More...

Public Types inherited from vlink::Node< ImplT, SecT >
using	StatusCallback = NodeImpl::StatusCallback
	Handler signature for status-change notifications. More...

Public Member Functions
template<typename ConfT , typename SecurityConfigT = Security::Config, typename = std::enable_if_t<std::is_base_of_v<Conf, ConfT>>>
	SecuritySubscriber (const ConfT &conf, SecurityConfigT &&sec_cfg={}, InitType type=InitType::kWithInit)
	Constructs a `SecuritySubscriber` from a typed configuration object. More...

template<typename SecurityConfigT = Security::Config>
	SecuritySubscriber (const std::string &url_str, SecurityConfigT &&sec_cfg={}, InitType type=InitType::kWithInit)
	Constructs a `SecuritySubscriber` from a URL string and installs the security configuration. More...

Public Member Functions inherited from vlink::Subscriber< MsgT, SecurityType::kWithSecurity >
	Subscriber (const ConfT &conf, InitType type=InitType::kWithInit)
	Constructs a subscriber from a typed transport configuration object. More...

	Subscriber (const std::string &url_str, InitType type=InitType::kWithInit)
	Constructs a subscriber from a URL string. More...

bool	listen (MsgCallback &&callback)
	Installs the receive callback that runs for every inbound message. More...

void	set_manual_unloan (bool manual_unloan) override
	Enables or disables manual-unloan mode for zero-copy receives. More...

void	set_latency_and_lost_enabled (bool enable)
	Toggles per-message latency and sample-loss measurement. More...

bool	is_latency_and_lost_enabled () const
	Reports whether latency and sample-loss tracking is currently active. More...

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

SampleLostInfo	get_lost () const
	Returns cumulative sample-delivery statistics. More...

void	mark_as_getter ()
	Promotes this subscriber to behave as a `Getter` (field-reader) at the transport layer. More...

Public Member Functions inherited from vlink::Node< ImplT, SecT >
virtual bool	init ()
	Initialises the node and its transport back-end. More...

virtual bool	deinit ()
	Tears the node down and releases all transport resources. More...

virtual void	interrupt ()
	Aborts any blocking wait on this node. More...

bool	has_inited () const
	Reports whether `init()` has been successfully called. More...

bool	is_support_loan () const
	Reports whether the transport supports zero-copy loaned buffers. More...

Bytes	loan (int64_t size)
	Allocates a loaned buffer from the transport memory pool. More...

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

virtual bool	is_manual_unloan () const
	Reports whether manual-unloan mode is currently active. More...

bool	suspend ()
	Suspends message delivery on this node. More...

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

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

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

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

class MessageLoop *	get_message_loop () const
	Returns the `MessageLoop` this node is currently attached to. More...

const AbstractNode *	get_abstract_node () const
	Returns the abstract-graph handle for runtime topology inspection. More...

Status::BasePtr	get_status (Status::Type type) const
	Retrieves the current status object for the requested category. More...

void	register_status_handler (StatusCallback &&callback)
	Registers a handler invoked whenever the node's status changes. More...

void	set_property (const std::string &prop, const std::string &value)
	Sets a transport-specific string-keyed property. More...

std::string	get_property (const std::string &prop) const
	Retrieves a previously set transport-specific property value. More...

TransportType	get_transport_type () const
	Returns the `TransportType` this node is bound to. More...

const std::string &	get_url () const
	Returns the URL string used to construct this node. More...

void	set_record_path (const std::string &path)
	Enables recording of inbound or outbound messages to a bag file. More...

void	set_ser_type (const std::string &ser_type, SchemaType schema_type=SchemaType::kUnknown)
	Overrides the runtime wire-metadata identifiers for this node. More...

const std::string &	get_ser_type () const
	Returns the current concrete runtime type identifier. More...

SchemaType	get_schema_type () const
	Returns the current coarse schema family. More...

void	set_discovery_enabled (bool enable)
	Toggles peer-discovery on this node. More...

bool	get_discovery_enabled () const
	Reports whether peer-discovery is currently enabled. More...

void	bind_proto_arena (void *proto_arena)
	Binds a Protobuf Arena for arena-allocated message objects. More...

double	get_cpu_usage () const
	Returns the cumulative CPU-usage ratio sampled by the profiler. More...

bool	get_safety_quit () const
	Reports whether safe-quit mode is currently active. More...

void	set_safety_quit (bool safety_quit)
	Enables or disables safe-quit mode. More...

void	set_ssl_options (const SslOptions &options)
	Configures transport-layer SSL/TLS encryption for this node. More...

Static Public Member Functions
template<typename SecurityConfigT = Security::Config>
static UniquePtr	create_unique (const std::string &url_str, SecurityConfigT &&sec_cfg={}, InitType type=InitType::kWithInit)
	Heap-allocates a `SecuritySubscriber` and wraps it in a `std::unique_ptr`. More...

template<typename SecurityConfigT = Security::Config>
static SharedPtr	create_shared (const std::string &url_str, SecurityConfigT &&sec_cfg={}, InitType type=InitType::kWithInit)
	Heap-allocates a `SecuritySubscriber` and wraps it in a `std::shared_ptr`. More...

Static Public Member Functions inherited from vlink::Subscriber< MsgT, SecurityType::kWithSecurity >
static UniquePtr	create_unique (const std::string &url_str, InitType type=InitType::kWithInit)
	Heap-allocates a `Subscriber` and wraps it in a `std::unique_ptr`. More...

static SharedPtr	create_shared (const std::string &url_str, InitType type=InitType::kWithInit)
	Heap-allocates a `Subscriber` and wraps it in a `std::shared_ptr`. More...

Additional Inherited Members
Static Public Attributes inherited from vlink::Subscriber< MsgT, SecurityType::kWithSecurity >
static constexpr ImplType	kImplType
	Node role tag (`kSubscriber`). More...

static constexpr Serializer::Type	kMsgType
	Codec resolved from `MsgT`. More...

Protected Member Functions inherited from vlink::Node< ImplT, SecT >
	Node ()

virtual	~Node ()

bool	enable_security (const Security::Config &cfg)
	Installs a `Security` configuration before transport initialisation. More...

bool	enable_security (Security::Config &&cfg)
	Move overload for construction-time security installation. More...

template<typename CallbackT , typename... ArgsT>
void	invoke_callback (const CallbackT &callback, ArgsT &&... args)

template<typename TypeT >
TypeT	get_default_value ()

Protected Attributes inherited from vlink::Node< ImplT, SecT >
void *	proto_arena_ {nullptr}

bool	is_support_loan_ {false}

bool	is_manual_unloan_ {false}

std::atomic_bool	has_inited_ {false}

std::optional< std::mutex >	quit_mtx_

std::unique_ptr< ImplT >	impl_

Detailed Description

template<typename MsgT>
class vlink::SecuritySubscriber< MsgT >

Convenience alias of Subscriber with per-message decryption enabled.

Equivalent to Subscriber<MsgT, SecurityType::kWithSecurity>. Every inbound payload is decrypted with the configured Security::Config before the codec dispatcher is invoked.

Note: Security is not supported on intra:// or on dds:// CDR payloads.

Template Parameters

MsgT	C++ message type to subscribe.

Member Typedef Documentation

◆ SharedPtr

template<typename MsgT >

using vlink::SecuritySubscriber< MsgT >::SharedPtr = std::shared_ptr<SecuritySubscriber<MsgT> >

Owning shared-pointer alias.

◆ UniquePtr

template<typename MsgT >

using vlink::SecuritySubscriber< MsgT >::UniquePtr = std::unique_ptr<SecuritySubscriber<MsgT> >

Owning unique-pointer alias.

Constructor & Destructor Documentation

◆ SecuritySubscriber() [1/2]

template<typename MsgT >

template<typename ConfT , typename SecurityConfigT , typename >

vlink::SecuritySubscriber< MsgT >::SecuritySubscriber	(	const ConfT &	conf,
		SecurityConfigT &&	sec_cfg = `{}`,
		InitType	type = `InitType::kWithInit`
	)

inlineexplicit

Constructs a SecuritySubscriber from a typed configuration object.

Template Parameters

ConfT	Configuration type derived from `Conf`.
SecurityConfigT	Forwardable `Security::Config` compatible type.

Parameters

conf	Populated configuration aggregate.
sec_cfg	Security configuration; empty uses the default symmetric slot.
type	Whether to call `init()` inline; default is `InitType::kWithInit`.

◆ SecuritySubscriber() [2/2]

template<typename MsgT >

template<typename SecurityConfigT >

vlink::SecuritySubscriber< MsgT >::SecuritySubscriber	(	const std::string &	url_str,
		SecurityConfigT &&	sec_cfg = `{}`,
		InitType	type = `InitType::kWithInit`
	)

inlineexplicit

Constructs a SecuritySubscriber from a URL string and installs the security configuration.

Builds the base Subscriber in kWithoutInit mode, installs sec_cfg via enable_security(), then calls init() unless deferred. When enable_security() fails to produce a usable NodeImpl::security the subsequent init() will fail.

Template Parameters

SecurityConfigT Forwardable Security::Config compatible type.

Parameters

url_str	Topic URL string.
sec_cfg	Security configuration; empty uses the default symmetric slot.
type	Whether to call `init()` inline; default is `InitType::kWithInit`.

Member Function Documentation

◆ create_shared()

template<typename MsgT >

template<typename SecurityConfigT >

SecuritySubscriber< MsgT >::SharedPtr vlink::SecuritySubscriber< MsgT >::create_shared	(	const std::string &	url_str,
		SecurityConfigT &&	sec_cfg = `{}`,
		InitType	type = `InitType::kWithInit`
	)

inlinestatic

Heap-allocates a SecuritySubscriber and wraps it in a std::shared_ptr.

Template Parameters

SecurityConfigT Forwardable Security::Config compatible type.

Parameters

url_str	Topic URL string.
sec_cfg	Security configuration; empty uses the default symmetric slot.
type	Whether to call `init()` inline; default is `InitType::kWithInit`.

Returns: Owning SharedPtr to the new secure subscriber.

◆ create_unique()

template<typename MsgT >

template<typename SecurityConfigT >

SecuritySubscriber< MsgT >::UniquePtr vlink::SecuritySubscriber< MsgT >::create_unique	(	const std::string &	url_str,
		SecurityConfigT &&	sec_cfg = `{}`,
		InitType	type = `InitType::kWithInit`
	)

inlinestatic

Heap-allocates a SecuritySubscriber and wraps it in a std::unique_ptr.

Template Parameters

SecurityConfigT Forwardable Security::Config compatible type.

Parameters

url_str	Topic URL string.
sec_cfg	Security configuration; empty uses the default symmetric slot.
type	Whether to call `init()` inline; default is `InitType::kWithInit`.

Returns: Owning UniquePtr to the new secure subscriber.

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

include/vlink/subscriber.h
include/vlink/internal/subscriber-inl.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<typename MsgT> class vlink::SecuritySubscriber< MsgT >

Member Typedef Documentation

◆ SharedPtr

◆ UniquePtr

Constructor & Destructor Documentation

◆ SecuritySubscriber() [1/2]

◆ SecuritySubscriber() [2/2]

Member Function Documentation

◆ create_shared()

◆ create_unique()

template<typename MsgT>
class vlink::SecuritySubscriber< MsgT >