DDS-aligned status enumeration, base event class, and helper predicates. More...

Classes
struct	Base
	Polymorphic base for every concrete status event delivered to a callback. More...

struct	Unknown
	Placeholder event emitted when the transport reports a status the runtime cannot map. More...

struct	PublicationMatched
	Writer-side event raised when a matching subscriber appears or disappears. More...

struct	OfferedDeadlineMissed
	Writer-side event raised when the writer fails to publish within its offered deadline. More...

struct	OfferedIncompatibleQos
	Writer-side event raised when a subscriber is rejected for incompatible QoS. More...

struct	LivelinessLost
	Writer-side event raised when the liveliness lease lapses without assertion. More...

struct	SubscriptionMatched
	Reader-side event raised when a matching publisher appears or disappears. More...

struct	RequestedDeadlineMissed
	Reader-side event raised when the reader does not receive data within its requested deadline. More...

struct	LivelinessChanged
	Reader-side event raised when the liveliness of a matched publisher changes. More...

struct	SampleRejected
	Reader-side event raised when an inbound sample is dropped due to a resource limit. More...

struct	RequestedIncompatibleQos
	Reader-side event raised when a publisher is rejected for incompatible QoS. More...

struct	SampleLost
	Reader-side event raised when a sample is lost between writer and reader. More...

Typedefs
using	InstanceHandle = const void *
	Opaque transport-defined identifier for a matched publication or subscription. More...

using	BasePtr = std::shared_ptr< Status::Base >
	Shared-pointer alias used as the parameter type of every status callback. More...

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 that identifies the concrete `Base` subclass carried by an event. More...

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

Detailed Description

DDS-aligned status enumeration, base event class, and helper predicates.

Typedef Documentation

◆ BasePtr

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

Shared-pointer alias used as the parameter type of every status callback.

◆ InstanceHandle

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

Opaque transport-defined identifier for a matched publication or subscription.

Treat as an opaque key; the bit pattern is transport-specific and is only meaningful when compared against handles obtained from the same transport.

Enumeration Type Documentation

◆ Type

enum vlink::Status::Type : uint8_t

Discriminator that identifies the concrete Base subclass carried by an event.

Values 1..4 are emitted on the writer side, values 5..10 on the reader side; use is_for_writer() / is_for_reader() to classify a value without inspecting the concrete subclass.

Enumerator
kUnknown	Placeholder for unrecognised status events.
kPublicationMatched	Matching subscriber appeared or disappeared.
kOfferedDeadlineMissed	Writer missed its offered publication deadline.
kOfferedIncompatibleQos	Discovered subscriber with incompatible QoS.
kLivelinessLost	Writer liveliness assertion lapsed.
kSubscriptionMatched	Matching publisher appeared or disappeared.
kRequestedDeadlineMissed	Reader missed its requested deadline.
kLivelinessChanged	Liveliness of a matched publisher changed.
kSampleRejected	Inbound sample dropped by resource limits.
kRequestedIncompatibleQos	Discovered publisher with incompatible QoS.
kSampleLost	Sample 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 an event.

Returns: Reference to ostream.

Classes

Typedefs

Enumerations

Functions