Struct RingBufferSynchronousProxy

pub struct RingBufferSynchronousProxy { /* private fields */ }

Implementations

impl RingBufferSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<RingBufferEvent, 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_active_channels( &self, payload: &RingBufferSetActiveChannelsRequest, ___deadline: MonotonicInstant, ) -> Result<RingBufferSetActiveChannelsResult, Error>

Request that specific individual channels be powered down/up, if the device supports this. This is intended for idle power conservation.

Channels are specified by bitmask; the least significant bit corresponds to channel 0. Each bit not set indicates that the channel can be deactivated. SetActiveChannels does not change how a ring buffer responds to Start/Stop, specifically with regards to position.

Devices are not required to obey SetActiveChannels. For example, they are not required to zero-out an input stream’s inactive channels, and data written to inactive channels of an output stream’s ring buffer may still be played.

If not called, then by default all channels will be active.

pub fn start( &self, payload: &RingBufferStartRequest, ___deadline: MonotonicInstant, ) -> Result<RingBufferStartResult, Error>

Start the ring buffer, beginning at the first frame of the ring buffer.

pub fn stop( &self, payload: &RingBufferStopRequest, ___deadline: MonotonicInstant, ) -> Result<RingBufferStopResult, Error>

Stop the ring buffer.

pub fn watch_delay_info( &self, ___deadline: MonotonicInstant, ) -> Result<RingBufferWatchDelayInfoResult, Error>

Request delay information via a hanging get. The RingBuffer will respond immediately to the first WatchDelayInfo call. Subsequent calls will only be completed when the delay info has changed from previously communicated values.

Trait Implementations

impl Debug for RingBufferSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for RingBufferSynchronousProxy

type Proxy = RingBufferProxy

The async proxy for the same protocol.

type Protocol = RingBufferMarker

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.