a11::net::SignallingTransport Class Reference

Abstract identity-bound channel over which signalling flows. More...

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

Inheritance diagram for a11::net::SignallingTransport:

Public Member Functions
virtual	~SignallingTransport ()=default
virtual absl::Status	Send (SignallingMessage message)=0
	Sends a signalling message to the peer (non-blocking).
virtual absl::Status	SetOnMessage (OnSignallingMessage on_message)=0
	Registers the async callback invoked for each inbound message.
virtual absl::Status	Close ()=0
	Closes the transport and releases its resources.
virtual std::string	identity () const =0
virtual bool	connected () const =0
virtual absl::Status	GetStatus () const =0

Detailed Description

Abstract identity-bound channel over which signalling flows.

The interface a WebRtcWireStream negotiates over; concrete implementations include the in-process SignallingEndpoint and the WebSocket-backed WebSocketSignallingClient.

Constructor & Destructor Documentation

~SignallingTransport()

virtual a11::net::SignallingTransport::~SignallingTransport ( )

virtualdefault

Member Function Documentation

Close()

virtual absl::Status a11::net::SignallingTransport::Close ( )

pure virtual

Closes the transport and releases its resources.

Implemented in a11::net::SignallingEndpoint, and a11::net::WebSocketSignallingClient.

connected()

virtual bool a11::net::SignallingTransport::connected ( ) const

pure virtual

Returns

Whether the transport is currently connected.

Implemented in a11::net::SignallingEndpoint, and a11::net::WebSocketSignallingClient.

GetStatus()

virtual absl::Status a11::net::SignallingTransport::GetStatus ( ) const

pure virtual

Returns

The current transport status.

Implemented in a11::net::SignallingEndpoint, and a11::net::WebSocketSignallingClient.

identity()

virtual std::string a11::net::SignallingTransport::identity ( ) const

pure virtual

Returns

The local identity bound to this transport.

Implemented in a11::net::SignallingEndpoint, and a11::net::WebSocketSignallingClient.

Send()

virtual absl::Status a11::net::SignallingTransport::Send ( SignallingMessage  message )

pure virtual

Sends a signalling message to the peer (non-blocking).

Implemented in a11::net::SignallingEndpoint, and a11::net::WebSocketSignallingClient.

SetOnMessage()

virtual absl::Status a11::net::SignallingTransport::SetOnMessage ( OnSignallingMessage  on_message )

pure virtual

Registers the async callback invoked for each inbound message.

Implemented in a11::net::SignallingEndpoint, and a11::net::WebSocketSignallingClient.

---

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

• cpp/a11/net/signalling.h