 |
VLink
2.0.0
A high-performance communication middleware
|
|
VLink
2.0.0
A high-performance communication middleware
|
Field-model writer base shared by every transport-specific setter. More...
#include <setter_impl.h>
Public Member Functions | |
| ~SetterImpl () override | |
| Releases backend resources. More... | |
| virtual void | write (const Bytes &msg_data)=0 |
| Writes a new value to every reachable getter. More... | |
| virtual void | sync (SyncCallback &&callback)=0 |
| Installs the transport-specific late-getter sync callback. 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... | |
Protected Member Functions | |
| SetterImpl () | |
Stamps the node as kSetter. 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... | |
| 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... | |
Field-model writer base shared by every transport-specific setter.
Backends override write() to dispatch the serialised value onto the transport and sync() to receive the transport-specific late-join notification so the public Setter can resend its cached value.
|
override |
Releases backend resources.
|
protected |
Stamps the node as kSetter.
|
pure virtual |
Installs the transport-specific late-getter sync callback.
Pure virtual. Backends that detect a freshly attached getter invoke callback so the public Setter can resend the cached latest value; transports without such a signal may simply discard the callback.
| callback | Callable invoked when a late-getter sync is requested. |
|
pure virtual |
Writes a new value to every reachable getter.
Pure virtual. msg_data is produced by Serializer::serialize() in the public layer; the call overwrites any previously stored value on the topic.
| msg_data | Serialised value bytes. |
1.9.1