Async Callback API on the transport. More...

#include <connection.h>

Inheritance diagram for quicr::Connection::Delegate:

Public Member Functions
virtual	~Delegate ()=default
	Destroy the delegate. More...

virtual void	OnConnectionStatus (const std::shared_ptr< Connection > &connection, Status status)=0
	Event notification for connection status changes. More...

virtual void	OnRecvDgram (const std::shared_ptr< Connection > &connection)=0
	callback notification that datagram data has been received and should be processed More...

virtual bool	OnRecvStream (const std::shared_ptr< Stream > &stream)=0
	callback notification that data has been received and should be processed More...

virtual void	OnStreamClosed (const std::shared_ptr< Stream > &stream, StreamClosedFlag flag)=0
	Callback notification that a stream has been closed by either FIN or RST. More...

virtual void	OnConnectionMetricsSampled (const std::shared_ptr< Connection > &connection, const MetricsTimeStamp sample_time, const QuicConnectionMetrics &quic_connection_metrics)=0
	callback notification on connection metrics sampled More...

virtual void	OnStreamMetricsStampled (const std::shared_ptr< Connection > &connection, const MetricsTimeStamp sample_time, std::uint64_t stream_id, const QuicStreamMetrics &quic_stream_metrics, bool is_final)=0
	callback notification on stream metrics sampled More...

Detailed Description

Async Callback API on the transport.

Constructor & Destructor Documentation

◆ ~Delegate()

virtual quicr::Connection::Delegate::~Delegate ( )

virtualdefault

Destroy the delegate.

Member Function Documentation

◆ OnConnectionMetricsSampled()

virtual void quicr::Connection::Delegate::OnConnectionMetricsSampled	(	const std::shared_ptr< Connection > &	connection,
		const MetricsTimeStamp	sample_time,
		const QuicConnectionMetrics &	quic_connection_metrics
	)

pure virtual

callback notification on connection metrics sampled

This callback will be called when the connection metrics are sampled per connection

Parameters

connection	Connection whose metrics were sampled
sample_time	Sample time in microseconds
quic_connection_metrics	Connection specific metrics for sample period

◆ OnConnectionStatus()

virtual void quicr::Connection::Delegate::OnConnectionStatus	(	const std::shared_ptr< Connection > &	connection,
		Status	status
	)

pure virtual

Event notification for connection status changes.

Called when the connection changes state/status

Parameters

[in]	connection	Connection whose status changed
[in]	status	Transport status value

◆ OnRecvDgram()

virtual void quicr::Connection::Delegate::OnRecvDgram ( const std::shared_ptr< Connection > & connection )

pure virtual

callback notification that datagram data has been received and should be processed

Datagrams share one queue per connection, so there is nothing to identify here beyond the connection itself.

◆ OnRecvStream()

virtual bool quicr::Connection::Delegate::OnRecvStream ( const std::shared_ptr< Stream > & stream )

pure virtual

callback notification that data has been received and should be processed

Parameters

stream Stream the data arrived on, carrying its receive queue and the handler consuming it.

Returns: true if the stream was left with more that can be read now, having stopped short of draining it so as not to starve the others, and so wants another turn

◆ OnStreamClosed()

virtual void quicr::Connection::Delegate::OnStreamClosed	(	const std::shared_ptr< Stream > &	stream,
		StreamClosedFlag	flag
	)

pure virtual

Callback notification that a stream has been closed by either FIN or RST.

Parameters

stream	Stream that closed, carrying the handler it belonged to
flag	Flag value for how the stream was closed. Values are FIN or RST

Implemented in quicr::Session.

◆ OnStreamMetricsStampled()

virtual void quicr::Connection::Delegate::OnStreamMetricsStampled	(	const std::shared_ptr< Connection > &	connection,
		const MetricsTimeStamp	sample_time,
		std::uint64_t	stream_id,
		const QuicStreamMetrics &	quic_stream_metrics,
		bool	is_final
	)

pure virtual

callback notification on stream metrics sampled

Called once per stream per sample period, before OnConnectionMetricsSampled for the same period. A track carried by several streams therefore accumulates several of these before its period is complete. A stream that closed during the period reports once more, so one that came and went between two samples still counts towards its track.

Note: Every value covers the period alone, so a running total simply adds each one.

Parameters

connection	Connection the stream belongs to
sample_time	Sample time in microseconds
stream_id	Stream the metrics belong to
quic_stream_metrics	Stream metrics for sample period
is_final	Last report for this stream; it no longer exists

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

include/quicr/connection.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Delegate()

Member Function Documentation

◆ OnConnectionMetricsSampled()

◆ OnConnectionStatus()

◆ OnRecvDgram()

◆ OnRecvStream()

◆ OnStreamClosed()

◆ OnStreamMetricsStampled()