vlink::Status Namespace Reference

DDS-compatible status type enumeration, base class, and type-safe cast utilities. More...

Classes
struct	Base
	Abstract base class for all VLink status event objects. More...
struct	Unknown
	Placeholder status returned when the transport reports an unrecognised event type. More...
struct	PublicationMatched
	Status event fired when a DataWriter gains or loses a matching DataReader. More...
struct	OfferedDeadlineMissed
	Status event fired when a DataWriter fails to publish within its offered deadline period. More...
struct	OfferedIncompatibleQos
	Status event fired when a DataWriter discovers a subscriber with incompatible QoS. More...
struct	LivelinessLost
	Status event fired when a DataWriter loses liveliness (failed to assert within duration). More...
struct	SubscriptionMatched
	Status event fired when a DataReader gains or loses a matching DataWriter. More...
struct	RequestedDeadlineMissed
	Status event fired when a DataReader does not receive data within its requested deadline. More...
struct	LivelinessChanged
	Status event fired when the liveliness state of a matched DataWriter changes. More...
struct	SampleRejected
	Status event fired when an incoming sample is rejected due to a resource limit. More...
struct	RequestedIncompatibleQos
	Status event fired when a DataReader discovers a publisher with incompatible QoS. More...
struct	SampleLost
	Status event fired when a sample is lost before it can be delivered to the DataReader. More...

Typedefs
using	InstanceHandle = const void*
	Opaque handle type for DDS instance identifiers.
using	BasePtr = std::shared_ptr<Status::Base>
	Type alias for a shared pointer to a base status event.

Enumerations
enum	Type : uint8_t {   kUnknown = 0 , kPublicationMatched = 1 , kOfferedDeadlineMissed = 2 , kOfferedIncompatibleQos = 3 ,   kLivelinessLost = 4 , kSubscriptionMatched = 5 , kRequestedDeadlineMissed = 6 , kLivelinessChanged = 7 ,   kSampleRejected = 8 , kRequestedIncompatibleQos = 9 , kSampleLost = 10 }
	Discriminator for concrete status event types. More...

Functions
VLINK_EXPORT std::ostream &	operator<< (std::ostream &ostream, const BasePtr &status) noexcept
	Writes the human-readable description of status to ostream.

Detailed Description

DDS-compatible status type enumeration, base class, and type-safe cast utilities.

Typedef Documentation

BasePtr

using vlink::Status::BasePtr = std::shared_ptr<Status::Base>

Type alias for a shared pointer to a base status event.

Used as the parameter type for status callbacks registered on publishers, subscribers, clients, servers, getters, and setters.

InstanceHandle

using vlink::Status::InstanceHandle = const void*

Opaque handle type for DDS instance identifiers.

Carries a transport-level pointer to the matched publication or subscription endpoint. The exact value is transport-specific and should be treated as opaque.

Enumeration Type Documentation

Type

enum vlink::Status::Type : uint8_t

Discriminator for concrete status event types.

Values below kSubscriptionMatched are writer-side events; values from kSubscriptionMatched onwards are reader-side events. Use is_for_writer() / is_for_reader() for category tests.

Enumerator
kUnknown	Unknown or uninitialised status.
kPublicationMatched	A matching subscriber appeared or was removed.
kOfferedDeadlineMissed	Writer missed its offered deadline.
kOfferedIncompatibleQos	Subscriber with incompatible QoS discovered.
kLivelinessLost	Writer liveliness assertion failed.
kSubscriptionMatched	A matching publisher appeared or was removed.
kRequestedDeadlineMissed	Reader did not receive data within its deadline.
kLivelinessChanged	Publisher liveliness state changed.
kSampleRejected	Incoming sample was rejected (resource limit).
kRequestedIncompatibleQos	Publisher with incompatible QoS discovered.
kSampleLost	Sample was lost before delivery.

Function Documentation

operator<<()

VLINK_EXPORT std::ostream & vlink::Status::operator<< ( std::ostream & ostream, const BasePtr & status )

noexcept

Writes the human-readable description of status to ostream.

Parameters

ostream	Output stream.
status	Shared pointer to a status event.

Returns

Reference to ostream.