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

Aggregate of cumulative delivered / lost sample counts. More...

#include <types.h>

Collaboration diagram for vlink::SampleLostInfo:

Public Attributes

uint64_t total {0}
 Total number of samples expected (delivered + lost). More...
 
uint64_t lost {0}
 Number of samples that were dropped or missed. More...
 

Friends

VLINK_EXPORT friend std::ostream & operator<< (std::ostream &ostream, const SampleLostInfo &info) noexcept
 Streams a human-readable summary to ostream. More...
 

Detailed Description

Aggregate of cumulative delivered / lost sample counts.

Returned by SubscriberImpl::get_lost() and GetterImpl::get_lost(). total counts every message that was expected (delivered or lost); lost counts the subset that did not arrive. Stream-friendly through operator<<.

Friends And Related Function Documentation

◆ operator<<

VLINK_EXPORT friend std::ostream& operator<< ( std::ostream &  ostream,
const SampleLostInfo info 
)
friend

Streams a human-readable summary to ostream.

Output format: "SampleLostInfo:[total]N[lost]M".

Parameters
ostreamDestination stream.
infoInstance to print.
Returns
Reference to ostream.

Member Data Documentation

◆ lost

uint64_t vlink::SampleLostInfo::lost {0}

Number of samples that were dropped or missed.

◆ total

uint64_t vlink::SampleLostInfo::total {0}

Total number of samples expected (delivered + lost).


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