Struct BlockSynchronousProxy

pub struct BlockSynchronousProxy { /* private fields */ }

Implementations

impl BlockSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<BlockEvent, 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 get_info( &self, ___deadline: MonotonicInstant, ) -> Result<BlockGetInfoResult, Error>

Get information about the underlying block device.

pub fn get_stats( &self, clear: bool, ___deadline: MonotonicInstant, ) -> Result<BlockGetStatsResult, Error>

Returns stats about block device operations. Setting clear will reset stats counters.

pub fn open_session( &self, session: ServerEnd<SessionMarker>, ) -> Result<(), Error>

Opens a new FIFO-based session on the block device.

pub fn open_session_with_offset_map( &self, session: ServerEnd<SessionMarker>, offset_map: Option<ClientEnd<OffsetMapMarker>>, initial_mappings: Option<&[BlockOffsetMapping]>, ) -> Result<(), Error>

Opens a new FIFO-based session on the block device, providing an offset lookup map which transparently translates device offsets in block FIFO requests.

initial_mappings is a static set of mappings which the server can immediately use. If offset_map is not provided, this must be non-empty, and requests that fall outside of the mapped range will fail.

If offset_map is provided, whenever the server receives a request with a dev_offset that falls outside of the known range, it will consult offset_map to attempt to resolve the offset. Because these offset mappings must be stable for the duration of the session, the server may cache any mappings.

This interface is intended to be used internally between nested Block implementations, in order to provide passthrough I/O. For example, a fixed partition map (e.g. GPT) will serve a Block protocol for each partition, and will respond to OpenSession requests by calling OpenSessionWithOffsetMap on the underlying block device, establishing itself as the source for translating client block offsets (relative to the partition start) to absolute offsets. The client can then communicate directly with the underlying block device, and the partition offsets can be transparently applied to requests.

Trait Implementations

impl Debug for BlockSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for BlockSynchronousProxy

type Proxy = BlockProxy

The async proxy for the same protocol.

type Protocol = BlockMarker

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.