VLink  2.0.0
A high-performance communication middleware
vlink::Status::Unknown Struct Referencefinal

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

#include <status.h>

Inheritance diagram for vlink::Status::Unknown:
Collaboration diagram for vlink::Status::Unknown:

Public Member Functions

Type get_type () const override
 Returns kUnknown. More...
 
std::string get_string () const override
 Returns the literal "Unknown". More...
 

Friends

VLINK_EXPORT friend std::ostream & operator<< (std::ostream &ostream, const Unknown &status) noexcept
 Writes "Unknown" to ostream. More...
 

Additional Inherited Members

Detailed Description

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

Callbacks normally short-circuit on get_type() == kUnknown to avoid attempting an invalid downcast.

Member Function Documentation

◆ get_string()

std::string vlink::Status::Unknown::get_string ( ) const
overridevirtual

Returns the literal "Unknown".

Returns
Descriptive string.

Implements vlink::Status::Base.

◆ get_type()

Type vlink::Status::Unknown::get_type ( ) const
overridevirtual

Returns kUnknown.

Returns
Always kUnknown.

Implements vlink::Status::Base.

Friends And Related Function Documentation

◆ operator<<

VLINK_EXPORT friend std::ostream& operator<< ( std::ostream &  ostream,
const Unknown status 
)
friend

Writes "Unknown" to ostream.

Parameters
ostreamOutput stream.
statusThis Unknown event.
Returns
Reference to ostream.

The documentation for this struct was generated from the following file: