Shared WireStream lifecycle and framing for binary channels. More...

#include <cpp/a11/net/channel_wire_stream.h>

Inheritance diagram for a11::net::ChannelWireStream:

Classes
struct	State

Public Types
using	OpenOperation = std::function< absl::Status()>
	Transport-specific operation that initiates or accepts the channel.

Public Member Functions
	~ChannelWireStream () override

absl::Status	Send (data::WireMessage message) override
	Enqueue a message for delivery to the peer.

a11::Task	Start (OnMessage on_message, OnDone on_done) override
	Begin the stream as the initiating ("start") side.

a11::Task	Accept (OnMessage on_message, OnDone on_done) override
	Begin the stream as the accepting ("accept") side.

absl::Status	HalfClose (data::ByteMap trailers) override
	Signal that this side will send no more messages.

a11::Task	DrainOutgoingMessages () override
	Await delivery of all buffered outbound messages.

absl::Status	Abort (absl::Status status) override
	Abort the stream, discarding buffered work.

absl::Status	SetDeadline (absl::Time deadline) override
	Set the absolute deadline after which the stream is aborted.

absl::Time	deadline () const override

absl::Status	GetStatus () const override

std::optional< data::ByteMap >	GetTrailers () const override

std::string	GetId () const override

void *absl_nullable	GetImpl () const override

absl::Status	HalfClose ()
	Half-close with no trailers.

virtual absl::Status	HalfClose (data::ByteMap trailers)=0
	Signal that this side will send no more messages.

absl::Status	SetDeadline ()
	Clear any deadline (equivalent to an infinite deadline).

virtual absl::Status	SetDeadline (absl::Time deadline)=0
	Set the absolute deadline after which the stream is aborted.

Public Member Functions inherited from a11::net::WireStream
virtual	~WireStream ()=default

absl::Status	HalfClose ()
	Half-close with no trailers.

absl::Status	SetDeadline ()
	Clear any deadline (equivalent to an infinite deadline).

Protected Member Functions
	ChannelWireStream (std::shared_ptr< State > state)

Static Protected Member Functions
static absl::StatusOr< std::shared_ptr< State > >	MakeState (std::shared_ptr< internal::BinaryChannel > channel, std::string id, ChannelEndpointRole role, OpenOperation open_operation, WireStreamOptions options, ChannelFramingOptions framing={})

Detailed Description

Shared WireStream lifecycle and framing for binary channels.

WebRTC data channels and WebSocket channels supply a small BinaryChannel adapter; this class supplies Action Engine packetisation, bounded reassembly, backpressure, deadlines, half-close, and abort semantics. External channel callbacks are handed into A11's scheduler before protocol or application work runs.

Member Typedef Documentation

◆ OpenOperation

using a11::net::ChannelWireStream::OpenOperation = std::function<absl::Status()>

Transport-specific operation that initiates or accepts the channel.

Constructor & Destructor Documentation

◆ ~ChannelWireStream()

a11::net::ChannelWireStream::~ChannelWireStream ( )

override

◆ ChannelWireStream()

a11::net::ChannelWireStream::ChannelWireStream ( std::shared_ptr< State > state )

inlineexplicitprotected

Member Function Documentation

◆ Abort()

absl::Status a11::net::ChannelWireStream::Abort ( absl::Status status )

overridevirtual

Abort the stream, discarding buffered work.

Parameters

status A non-OK status reported to the peer as the abort reason.

Returns: OK if the abort was accepted.

Implements a11::net::WireStream.

◆ Accept()

a11::Task a11::net::ChannelWireStream::Accept	(	OnMessage	on_message,
		OnDone	on_done
	)

overridevirtual

Begin the stream as the accepting ("accept") side.

Parameters

on_message	Invoked for each inbound message (nullopt = peer half-closed).
on_done	Invoked once when the stream has finished.

Returns: An awaitable that resolves once the stream is accepted.

Implements a11::net::WireStream.

◆ deadline()

absl::Time a11::net::ChannelWireStream::deadline ( ) const

overridevirtual

Returns: The stream's current deadline.

Implements a11::net::WireStream.

◆ DrainOutgoingMessages()

a11::Task a11::net::ChannelWireStream::DrainOutgoingMessages ( )

overridevirtual

Await delivery of all buffered outbound messages.

Returns: An awaitable that resolves once this endpoint's queued messages have been flushed to the transport (requires a prior HalfClose).

Implements a11::net::WireStream.

◆ GetId()

std::string a11::net::ChannelWireStream::GetId ( ) const

overridevirtual

Returns: This stream's transport-assigned identifier.

Implements a11::net::WireStream.

◆ GetImpl()

void *absl_nullable a11::net::ChannelWireStream::GetImpl ( ) const

overridevirtual

Returns: An opaque handle to the underlying transport object (advanced; may be null).

Implements a11::net::WireStream.

◆ GetStatus()

absl::Status a11::net::ChannelWireStream::GetStatus ( ) const

overridevirtual

Returns: The stream's terminal status (OK unless it failed or was aborted).

Implements a11::net::WireStream.

◆ GetTrailers()

std::optional< data::ByteMap > a11::net::ChannelWireStream::GetTrailers ( ) const

overridevirtual

Returns: The peer's closing trailers, if the stream has received them.

Implements a11::net::WireStream.

◆ HalfClose() [1/3]

absl::Status a11::net::WireStream::HalfClose ( )

inline

Half-close with no trailers.

See also: HalfClose(data::ByteMap)

◆ HalfClose() [2/3]

absl::Status a11::net::ChannelWireStream::HalfClose ( data::ByteMap trailers )

overridevirtual

Signal that this side will send no more messages.

The terminal marker is queued after buffered outbound messages and, once the peer also half-closes, the stream completes. Inbound messages continue to be delivered until then. Call DrainOutgoingMessages() to await local transport delivery.

Parameters

trailers Optional closing metadata delivered to the peer.

Returns: OK, or a non-OK status if the stream cannot be half-closed.

Implements a11::net::WireStream.

◆ HalfClose() [3/3]

virtual absl::Status a11::net::WireStream::HalfClose ( data::ByteMap trailers )

virtual

Signal that this side will send no more messages.

The terminal marker is queued after buffered outbound messages and, once the peer also half-closes, the stream completes. Inbound messages continue to be delivered until then. Call DrainOutgoingMessages() to await local transport delivery.

Parameters

trailers Optional closing metadata delivered to the peer.

Returns: OK, or a non-OK status if the stream cannot be half-closed.

Implements a11::net::WireStream.

◆ MakeState()

absl::StatusOr< std::shared_ptr< ChannelWireStream::State > > a11::net::ChannelWireStream::MakeState	(	std::shared_ptr< internal::BinaryChannel >	channel,
		std::string	id,
		ChannelEndpointRole	role,
		OpenOperation	open_operation,
		WireStreamOptions	options,
		ChannelFramingOptions	framing = `{}`
	)

staticprotected

◆ Send()

absl::Status a11::net::ChannelWireStream::Send ( data::WireMessage message )

overridevirtual

Enqueue a message for delivery to the peer.

Non-blocking.

The message is admitted to this endpoint's outbound queue and delivered asynchronously by the transport task, which is also where backpressure is applied; there is no delivery-order guarantee across messages (see the class comment).

Parameters

message The message to send.

Returns: OK once the message is queued, or a non-OK status if the stream is not writable (e.g. already half-closed or aborted).

Implements a11::net::WireStream.

◆ SetDeadline() [1/3]

absl::Status a11::net::WireStream::SetDeadline ( )

inline

Clear any deadline (equivalent to an infinite deadline).

◆ SetDeadline() [2/3]

absl::Status a11::net::ChannelWireStream::SetDeadline ( absl::Time deadline )

overridevirtual

Set the absolute deadline after which the stream is aborted.

Parameters

deadline The deadline; absl::InfiniteFuture() disables it.

Implements a11::net::WireStream.

◆ SetDeadline() [3/3]

virtual absl::Status a11::net::WireStream::SetDeadline ( absl::Time deadline )

virtual

Set the absolute deadline after which the stream is aborted.

Parameters

deadline The deadline; absl::InfiniteFuture() disables it.

Implements a11::net::WireStream.

◆ Start()

a11::Task a11::net::ChannelWireStream::Start	(	OnMessage	on_message,
		OnDone	on_done
	)

overridevirtual

Begin the stream as the initiating ("start") side.

Parameters

on_message	Invoked for each inbound message (nullopt = peer half-closed).
on_done	Invoked once when the stream has finished.

Returns: An awaitable that resolves once the startup handshake completes.

Implements a11::net::WireStream.

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

cpp/a11/net/channel_wire_stream.h
cpp/a11/net/channel_wire_stream.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ OpenOperation

Constructor & Destructor Documentation

◆ ~ChannelWireStream()

◆ ChannelWireStream()

Member Function Documentation

◆ Abort()

◆ Accept()

◆ deadline()

◆ DrainOutgoingMessages()

◆ GetId()

◆ GetImpl()

◆ GetStatus()

◆ GetTrailers()

◆ HalfClose() [1/3]

◆ HalfClose() [2/3]

◆ HalfClose() [3/3]

◆ MakeState()

◆ Send()

◆ SetDeadline() [1/3]

◆ SetDeadline() [2/3]

◆ SetDeadline() [3/3]

◆ Start()