 |
VLink 2.0.0
A high-performance communication middleware
|
|
VLink 2.0.0
A high-performance communication middleware
|
Convenience alias for Subscriber with message security enabled.
More...
#include <subscriber.h>
Additional Inherited Members | |
| Public Types inherited from vlink::Subscriber< MsgT, SecurityType::kWithSecurity > | |
| using | UniquePtr |
| Unique-pointer alias for heap allocation. | |
| using | SharedPtr |
| Shared-pointer alias for heap allocation. | |
| using | MsgCallback |
| User-facing callback type for received messages. | |
| Public Types inherited from vlink::Node< SubscriberImpl, SecT > | |
| using | StatusCallback |
| Callback type for node status-change notifications. | |
| 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. | |
| bool | listen (MsgCallback &&callback) |
| Registers the receive callback for incoming messages. | |
| void | set_manual_unloan (bool manual_unloan) override |
| Enables or disables manual-unloan mode for zero-copy receives. | |
| void | set_latency_and_lost_enabled (bool enable) |
| Enables or disables per-message latency and sample-loss tracking. | |
| bool | is_latency_and_lost_enabled () const |
Returns true if latency and sample-loss tracking is active. | |
| int64_t | get_latency () const |
| Returns the most recently measured end-to-end message latency. | |
| SampleLostInfo | get_lost () const |
| Returns cumulative sample delivery statistics. | |
| void | mark_as_getter () |
Changes this subscriber's role to kGetter (field-reader). | |
| Public Member Functions inherited from vlink::Node< SubscriberImpl, SecT > | |
| virtual bool | init () |
| Initialises the node and its transport back-end. | |
| virtual bool | deinit () |
| Shuts down the node and releases all transport resources. | |
| virtual void | interrupt () |
| Unblocks any active blocking wait on this node. | |
| bool | has_inited () const |
Returns true if init() has been successfully called. | |
| bool | is_support_loan () const |
Returns true if the transport supports zero-copy loaned buffers. | |
| Bytes | loan (int64_t size) |
| Allocates a loaned buffer from the transport memory pool. | |
| bool | return_loan (const Bytes &bytes) |
| Returns a previously loaned buffer back to the transport pool. | |
| virtual bool | is_manual_unloan () const |
Returns true if manual-unloan mode is active. | |
| bool | suspend () |
| Suspends message delivery on this node. | |
| bool | resume () |
Resumes message delivery after a suspend(). | |
| bool | is_suspend () const |
Returns true if the node is currently suspended. | |
| bool | attach (class MessageLoop *message_loop) |
Attaches the node to a MessageLoop for callback dispatching. | |
| bool | detach () |
Detaches the node from its current MessageLoop. | |
| class MessageLoop * | get_message_loop () const |
Returns the MessageLoop this node is attached to. | |
| const AbstractNode * | get_abstract_node () const |
| Returns the abstract node handle for graph introspection. | |
| Status::BasePtr | get_status (Status::Type type) const |
| Returns the current status object for the specified status type. | |
| void | register_status_handler (StatusCallback &&callback) |
| Registers a handler called when the node's status changes. | |
| void | set_property (const std::string &prop, const std::string &value) |
| Sets a transport-specific key-value property on the node. | |
| std::string | get_property (const std::string &prop) const |
| Retrieves a transport-specific property value. | |
| TransportType | get_transport_type () const |
Returns the TransportType of the transport this node is bound to. | |
| const std::string & | get_url () const |
| Returns the URL string used to construct this node. | |
| void | set_security_key (const std::string &key) |
| Sets the symmetric encryption key for message security. | |
| void | set_record_path (const std::string &path) |
| Sets the filesystem path for message bag recording. | |
| void | set_security_callbacks (Security::Callback &&encrypt_callback, Security::Callback &&decrypt_callback) |
| Installs custom encrypt and decrypt callbacks. | |
| void | set_ser_type (const std::string &ser_type, SchemaType schema_type=SchemaType::kUnknown) |
| Overrides the runtime wire metadata for this node. | |
| const std::string & | get_ser_type () const |
| Returns the current serialisation type string. | |
| SchemaType | get_schema_type () const |
| Returns the current coarse schema family. | |
| void | set_discovery_enabled (bool enable) |
| Enables or disables peer-discovery on this node. | |
| bool | get_discovery_enabled () const |
Returns true if peer-discovery is currently enabled. | |
| void | bind_proto_arena (void *proto_arena) |
| Binds a Protobuf Arena for arena-allocated message objects. | |
| double | get_cpu_usage () const |
| Returns the cumulative CPU usage ratio for this node. | |
| bool | get_safety_quit () const |
Returns true if safe-quit mode is currently active. | |
| void | set_safety_quit (bool safety_quit) |
| Enables or disables safe-quit mode. | |
| void | set_ssl_options (const SslOptions &options) |
| Configures transport-layer SSL/TLS encryption for this node. | |
| Static Public Member Functions inherited from vlink::Subscriber< MsgT, SecurityType::kWithSecurity > | |
| static UniquePtr | create_unique (const std::string &url_str, InitType type=InitType::kWithInit) |
Creates a Subscriber on the heap wrapped in a unique_ptr. | |
| static SharedPtr | create_shared (const std::string &url_str, InitType type=InitType::kWithInit) |
Creates a Subscriber on the heap wrapped in a shared_ptr. | |
| Static Public Attributes inherited from vlink::Subscriber< MsgT, SecurityType::kWithSecurity > | |
| static constexpr ImplType | kImplType |
Node role identifier (kSubscriber). | |
| static constexpr Serializer::Type | kMsgType |
Serializer type resolved at compile time from MsgT. | |
| Protected Member Functions inherited from vlink::Node< SubscriberImpl, SecT > | |
| Node () | |
| virtual | ~Node () |
| void | enable_security () |
| void | invoke_callback (const CallbackT &callback, ArgsT &&... args) |
| TypeT | get_default_value () |
| Protected Attributes inherited from vlink::Node< SubscriberImpl, SecT > | |
| std::atomic_bool | has_inited_ |
| std::unique_ptr< SubscriberImpl > | impl_ |
| std::optional< Security > | security_ |
| std::optional< std::mutex > | quit_mtx_ |
| void * | proto_arena_ |
| bool | is_support_loan_ |
| bool | is_manual_unloan_ |
Convenience alias for Subscriber with message security enabled.
Equivalent to Subscriber<MsgT, SecurityType::kWithSecurity>. Decrypts every incoming message using the configured security key or callbacks.
intra:// or dds:// CDR transport.| MsgT | Message type. |
1.16.1