VLink 2.0.0
A high-performance communication middleware
Loading...
Searching...
No Matches
vlink::ProxyAPI::Info Struct Referencefinal

Statistics and metadata for a single discovered topic endpoint. More...

#include <proxy_api.h>

Collaboration diagram for vlink::ProxyAPI::Info:

Public Attributes

uint32_t type {0}
 Node type bitmask for this endpoint.
std::string url
 Full topic URL, e.g. "dds://my/topic".
std::string ser
 Serialisation type, e.g. "demo.proto.PointCloud".
SchemaType schema {SchemaType::kUnknown}
 Coarse schema family of the payload.
Status status {kInvalid}
 Activity status of the topic.
float freq {0}
 Observed message frequency in messages/s.
uint64_t rate {0}
 Observed throughput in bytes/s.
float loss {0}
 Sample loss ratio in the range [0, 1].
float latency {0}
 End-to-end latency in milliseconds.
std::vector< Processprocess_list
 List of connected publisher/subscriber processes.

Detailed Description

Statistics and metadata for a single discovered topic endpoint.

Delivered in batches via InfoCallback once per second. The fields freq, rate, loss, and latency are weighted moving averages computed over the last two 1-second collection intervals.

Member Data Documentation

◆ freq

float vlink::ProxyAPI::Info::freq {0}

Observed message frequency in messages/s.

◆ latency

float vlink::ProxyAPI::Info::latency {0}

End-to-end latency in milliseconds.

◆ loss

float vlink::ProxyAPI::Info::loss {0}

Sample loss ratio in the range [0, 1].

◆ process_list

std::vector<Process> vlink::ProxyAPI::Info::process_list

List of connected publisher/subscriber processes.

◆ rate

uint64_t vlink::ProxyAPI::Info::rate {0}

Observed throughput in bytes/s.

◆ schema

SchemaType vlink::ProxyAPI::Info::schema {SchemaType::kUnknown}

Coarse schema family of the payload.

◆ ser

std::string vlink::ProxyAPI::Info::ser

Serialisation type, e.g. "demo.proto.PointCloud".

◆ status

Status vlink::ProxyAPI::Info::status {kInvalid}

Activity status of the topic.

◆ type

uint32_t vlink::ProxyAPI::Info::type {0}

Node type bitmask for this endpoint.

◆ url

std::string vlink::ProxyAPI::Info::url

Full topic URL, e.g. "dds://my/topic".


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