phyphox::TransferSession Class Reference

#include <Transfer.h>

Public Types
enum	State : uint8_t {   IDLE , HEADER , BODY , DONE ,   ABORTED }

Public Member Functions
void	begin (const ByteSource &source, uint16_t payload)
	Start a transfer of source with payload bytes per packet (MTU − 3).
void	holdUntil (uint32_t untilMs)
	Do not send before untilMs (the start delay).
void	abort ()
void	reset ()
	back to idle after the bookkeeping
bool	active () const
State	state () const
uint16_t	nextPacket (uint8_t *out, uint32_t nowMs)
	Fill out with the packet to send now (header first, then body).
void	accepted ()
	The transport's verdict on the packet last returned by nextPacket().
void	refused (uint32_t nowMs)
uint32_t	bytesSent () const
uint32_t	lastProgressMs () const
	Milliseconds of the last accepted packet (or of begin()); the Server's stall watchdog.
void	noteProgress (uint32_t nowMs)
uint16_t	packetsSent () const
uint16_t	retries () const

Member Enumeration Documentation

State

enum phyphox::TransferSession::State : uint8_t

Enumerator
IDLE
HEADER
BODY
DONE
ABORTED

Member Function Documentation

abort()

void phyphox::TransferSession::abort ( )

inline

accepted()

void phyphox::TransferSession::accepted

(

)

The transport's verdict on the packet last returned by nextPacket().

active()

bool phyphox::TransferSession::active ( ) const

inline

begin()

void phyphox::TransferSession::begin	(	const ByteSource &	source,
		uint16_t	payload
	)

Start a transfer of source with payload bytes per packet (MTU − 3).

bytesSent()

uint32_t phyphox::TransferSession::bytesSent ( ) const

inline

holdUntil()

void phyphox::TransferSession::holdUntil ( uint32_t  untilMs )

inline

Do not send before untilMs (the start delay).

lastProgressMs()

uint32_t phyphox::TransferSession::lastProgressMs ( ) const

inline

Milliseconds of the last accepted packet (or of begin()); the Server's stall watchdog.

nextPacket()

uint16_t phyphox::TransferSession::nextPacket	(	uint8_t *	out,
		uint32_t	nowMs
	)

Fill out with the packet to send now (header first, then body).

Returns its length, 0 when nothing is due (done, aborted, or waiting out a retry delay — see retryAt).

noteProgress()

void phyphox::TransferSession::noteProgress ( uint32_t  nowMs )

inline

packetsSent()

uint16_t phyphox::TransferSession::packetsSent ( ) const

inline

refused()

void phyphox::TransferSession::refused

(

uint32_t

nowMs

)

reset()

void phyphox::TransferSession::reset ( )

inline

back to idle after the bookkeeping

retries()

uint16_t phyphox::TransferSession::retries ( ) const

inline

state()

State phyphox::TransferSession::state ( ) const

inline

---

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

• src/core/Transfer.h