Struct PeerControllerSynchronousProxy

pub struct PeerControllerSynchronousProxy { /* private fields */ }

Implementations

impl PeerControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<PeerControllerEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn set_configuration( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerSetConfigurationResult, Error>

Initiate a stream configuration procedure. No configuration information is specified because generic config information will be used to initiate the procedure.

pub fn get_configuration( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerGetConfigurationResult, Error>

Initiate a procedure to get the configuration information of the peer stream. The result is discarded because PeerController only initiates the procedure.

pub fn suspend_stream( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerSuspendStreamResult, Error>

Initiate a suspend request to the stream. This command will not resume nor reconfigure the stream.

pub fn suspend_and_reconfigure( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerSuspendAndReconfigureResult, Error>

A “chained” set of procedures on the current stream. SuspendStream() followed by ReconfigureStream(). Reconfigure() configures the stream that is currently open.

pub fn establish_stream( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerEstablishStreamResult, Error>

Initiate stream establishment with the peer.

pub fn release_stream( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerReleaseStreamResult, Error>

Release the current stream that is owned by the peer. If the streaming channel doesn’t exist, no action will be taken.

pub fn abort_stream( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerAbortStreamResult, Error>

Initiate an abort procedure on the current stream. If the streaming channel doesn’t exist, no action will be taken.

pub fn start_stream( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerStartStreamResult, Error>

Start streaming media on the current stream that is owned by the peer. If the streaming channel doesn’t exist, no action will be taken.

pub fn reconfigure_stream( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerReconfigureStreamResult, Error>

Initiate a reconfiguration procedure for the current stream. No configuration information is specified because a generic set of config information will be used to initiate the procedure.

pub fn get_capabilities( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerGetCapabilitiesResult, Error>

Initiate a procedure to get the capabilities of the peer. The result is discarded because PeerController only initiates the procedure.

pub fn get_all_capabilities( &self, ___deadline: MonotonicInstant, ) -> Result<PeerControllerGetAllCapabilitiesResult, Error>

Initiate a procedure to get the capabilities of the peer. The result is discarded because PeerController only initiates the procedure.

Trait Implementations

impl Debug for PeerControllerSynchronousProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SynchronousProxy for PeerControllerSynchronousProxy

type Proxy = PeerControllerProxy

The async proxy for the same protocol.

type Protocol = PeerControllerMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.