#include <GPSDeadline.h>

Public Member Functions
std::chrono::milliseconds	remaining (uint64_t nowUs) const
	Rounded up to whole milliseconds and capped at INT32_MAX milliseconds.

Static Public Member Functions
static GPSDeadline	after (uint64_t nowUs, std::chrono::microseconds timeout)
	A negative timeout is already due at nowUs.

Public Attributes
uint64_t	untilUs = UINT64_MAX

Detailed Description

An absolute deadline on the session's GPSClock, which may be virtual. Only GPSDriver's I/O adapter converts it to the QDeadlineTimer the transports wait on.

Definition at line 9 of file GPSDeadline.h.

Member Function Documentation

◆ after()

static GPSDeadline GPSDeadline::after	(	uint64_t	nowUs,
		std::chrono::microseconds	timeout
	)

inlinestatic

A negative timeout is already due at nowUs.

Definition at line 14 of file GPSDeadline.h.

Referenced by GPSCommandChannel::beginCommand(), GPSReceiverDetector::detect(), GPSCommandChannel::read(), GPSCommandChannel::receiveFor(), and GPSCommandChannel::receiveUntil().

◆ remaining()

std::chrono::milliseconds GPSDeadline::remaining ( uint64_t nowUs ) const

inline

Rounded up to whole milliseconds and capped at INT32_MAX milliseconds.

Definition at line 20 of file GPSDeadline.h.

References untilUs.

Referenced by GPSCommandChannel::awaitReply(), GPSReceiverDetector::detect(), GPSNMEAStream::limitReceiveTimeout(), GPSCommandChannel::receiveFor(), and GPSCommandChannel::receiveUntil().

Member Data Documentation

◆ untilUs

uint64_t GPSDeadline::untilUs = UINT64_MAX

Definition at line 11 of file GPSDeadline.h.

Referenced by GPSCommandChannel::awaitReply(), GPSCommandChannel::beginCommand(), GPSReceiverDetector::detect(), GPSDeadlineScope::GPSDeadlineScope(), GPSCommandChannel::read(), GPSCommandChannel::receiveCycle(), GPSCommandChannel::receiveFor(), GPSCommandChannel::receiveUntil(), remaining(), GPSCommandChannel::wait(), and GPSCommandChannel::write().

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

src/GPS/Core/Protocols/GPSDeadline.h

Public Member Functions