vlink::ProxyAPI::Info Struct Reference

Statistics and metadata describing one 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. More...
std::string	url
	Full topic URL, e.g. "dds://my/topic". More...
std::string	ser
	Serialisation type, e.g. "demo.proto.PointCloud". More...
SchemaType	schema {SchemaType::kUnknown}
	Coarse schema family of the payload. More...
Status	status {kInvalid}
	Current activity status of the topic. More...
float	freq {0}
	Observed message rate in messages/s. More...
uint64_t	rate {0}
	Observed throughput in bytes/s. More...
float	loss {0}
	Sample loss ratio in the range [0, 1]. More...
float	latency {0}
	Latency in ms; -1 = no sample, -2 = invalid. More...
std::vector< Process >	process_list
	Connected publisher/subscriber processes. More...

Detailed Description

Statistics and metadata describing one discovered topic endpoint.

Delivered in batches through InfoCallback once per second. freq, rate, loss, and latency are weighted moving averages over the last two one-second collection intervals.

Member Data Documentation

freq

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

Observed message rate in messages/s.

latency

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

Latency in ms; -1 = no sample, -2 = invalid.

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

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}

Current 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:

• include/vlink/external/proxy_api.h