QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
GPSRuntimeIO Struct Reference

#include <GPSProtocolRuntime.h>

+ Collaboration diagram for GPSRuntimeIO:

Public Attributes

std::function< GPSReadResult(std::span< uint8_t >, GPSDeadline)> read {}
 
std::function< GPSWriteResult(std::span< const uint8_t >, GPSDeadline)> write {}
 
std::function< GPSBaudStatus(unsigned)> setBaudrate {}
 
GPSClock clock {}
 Without a wait, the runtime sleeps in short slices until the duration elapses or cancelToken is cancelled.
 
GPSCancelToken cancelToken {}
 Checked before each write and baud change; reads observe it in the transport.
 

Detailed Description

Blocking transport services. Protocol code never calls these directly: it calls GPSCommandChannel operations, which apply deadlines, evidence and sticky failure around each call. A missing read fails, a missing write or baud change is unsupported.

Definition at line 23 of file GPSProtocolRuntime.h.

Member Data Documentation

◆ cancelToken

GPSCancelToken GPSRuntimeIO::cancelToken {}

Checked before each write and baud change; reads observe it in the transport.

Definition at line 31 of file GPSProtocolRuntime.h.

Referenced by GPSDriver::configure(), GPSProtocolRuntime::GPSProtocolRuntime(), and GPSCommandChannel::write().

◆ clock

GPSClock GPSRuntimeIO::clock {}

Without a wait, the runtime sleeps in short slices until the duration elapses or cancelToken is cancelled.

Definition at line 29 of file GPSProtocolRuntime.h.

Referenced by GPSDriver::configure(), GPSReceiverDetector::detect(), GPSProtocolRuntime::GPSProtocolRuntime(), and GPSCommandChannel::wait().

◆ read

std::function<GPSReadResult(std::span<uint8_t>, GPSDeadline)> GPSRuntimeIO::read {}

◆ setBaudrate

std::function<GPSBaudStatus(unsigned)> GPSRuntimeIO::setBaudrate {}

◆ write

std::function<GPSWriteResult(std::span<const uint8_t>, GPSDeadline)> GPSRuntimeIO::write {}

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