Struct FDomainSynchronousProxy 

pub struct FDomainSynchronousProxy { /* private fields */ }

Implementations

impl FDomainSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<FDomainEvent, 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 create_channel( &self, handles: &[NewHandleId; 2], ___deadline: MonotonicInstant, ) -> Result<ChannelCreateChannelResult, Error>

Create a new channel in this FDomain and return both its ends.

pub fn read_channel( &self, handle: &HandleId, ___deadline: MonotonicInstant, ) -> Result<ChannelReadChannelResult, Error>

Read a message from a channel. This method will fail if the channel is currently being read using the streaming read functions.

Note that this method is not like zx_channel_read in that it will not return SHOULD_WAIT but will instead delay returning until there is data to return.

pub fn write_channel( &self, handle: &HandleId, data: &[u8], handles: &Handles, ___deadline: MonotonicInstant, ) -> Result<ChannelWriteChannelResult, Error>

Write to a channel. Handles are always consumed.

pub fn read_channel_streaming_start( &self, handle: &HandleId, ___deadline: MonotonicInstant, ) -> Result<ChannelReadChannelStreamingStartResult, Error>

Starts reading from the given channel. Data is returned via the ChannelStreamingData event. That event will occur repeatedly until ReadChannelStreamingStop is called for the same handle or the event indicates the handle is closed.

pub fn read_channel_streaming_stop( &self, handle: &HandleId, ___deadline: MonotonicInstant, ) -> Result<ChannelReadChannelStreamingStopResult, Error>

Stop asynchronous reading from the given channel.

pub fn create_event( &self, handle: &NewHandleId, ___deadline: MonotonicInstant, ) -> Result<EventCreateEventResult, Error>

Create a new event in this FDomain and return it.

pub fn create_event_pair( &self, handles: &[NewHandleId; 2], ___deadline: MonotonicInstant, ) -> Result<EventPairCreateEventPairResult, Error>

Create a new event pair in this FDomain and return both its ends.

pub fn create_socket( &self, options: SocketType, handles: &[NewHandleId; 2], ___deadline: MonotonicInstant, ) -> Result<SocketCreateSocketResult, Error>

Create a new socket in this FDomain and return both its ends.

pub fn set_socket_disposition( &self, handle: &HandleId, disposition: SocketDisposition, disposition_peer: SocketDisposition, ___deadline: MonotonicInstant, ) -> Result<SocketSetSocketDispositionResult, Error>

Set the disposition of a given socket.

pub fn read_socket( &self, handle: &HandleId, max_bytes: u64, ___deadline: MonotonicInstant, ) -> Result<SocketReadSocketResult, Error>

Read data from a socket. This method will fail if the socket is currently being read asynchronously.

pub fn write_socket( &self, handle: &HandleId, data: &[u8], ___deadline: MonotonicInstant, ) -> Result<SocketWriteSocketResult, Error>

Write to a socket. This will attempt to write all the data passed, and will block and retry whenever it is safe (e.g. it should never return SHOULD_WAIT). The WriteSocketError contains a wrote parameter to indicate if some bytes were written successfully before the failure occurred.

pub fn read_socket_streaming_start( &self, handle: &HandleId, ___deadline: MonotonicInstant, ) -> Result<SocketReadSocketStreamingStartResult, Error>

Starts reading from the given socket. Data is returned via the SocketStreamingData event. That event will occur repeatedly until ReadSocketStreamingStop is called for the same handle or the event indicates the handle is closed.

pub fn read_socket_streaming_stop( &self, handle: &HandleId, ___deadline: MonotonicInstant, ) -> Result<SocketReadSocketStreamingStopResult, Error>

Stop asynchronous reading from the given socket.

pub fn get_namespace( &self, new_handle: &NewHandleId, ___deadline: MonotonicInstant, ) -> Result<FDomainGetNamespaceResult, Error>

Adds a new channel handle to this namespace which points to a fuchsia.io.Directory. Can be used to “bootstrap” the FDomain.

pub fn close( &self, handles: &[HandleId], ___deadline: MonotonicInstant, ) -> Result<FDomainCloseResult, Error>

Close one or more handles.

pub fn duplicate( &self, handle: &HandleId, new_handle: &NewHandleId, rights: Rights, ___deadline: MonotonicInstant, ) -> Result<FDomainDuplicateResult, Error>

Duplicate a handle.

pub fn replace( &self, handle: &HandleId, new_handle: &NewHandleId, rights: Rights, ___deadline: MonotonicInstant, ) -> Result<FDomainReplaceResult, Error>

Close a handle and replace it with a new one with possibly different rights.

pub fn signal( &self, handle: &HandleId, set: u32, clear: u32, ___deadline: MonotonicInstant, ) -> Result<FDomainSignalResult, Error>

Set or clear signals on a handle.

pub fn signal_peer( &self, handle: &HandleId, set: u32, clear: u32, ___deadline: MonotonicInstant, ) -> Result<FDomainSignalPeerResult, Error>

Set or clear signals on a handle’s peer.

pub fn wait_for_signals( &self, handle: &HandleId, signals: u32, ___deadline: MonotonicInstant, ) -> Result<FDomainWaitForSignalsResult, Error>

Wait for signals from the given handle. Reply will be returned when one of the given signals is asserted.

pub fn get_koid( &self, handle: &HandleId, ___deadline: MonotonicInstant, ) -> Result<FDomainGetKoidResult, Error>

Return the kernel object ID (koid) of the handle.

Trait Implementations

impl Debug for FDomainSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for FDomainSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<FDomainSynchronousProxy> for NullableHandle

Available on Fuchsia only.

fn from(value: FDomainSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for FDomainSynchronousProxy

Available on Fuchsia only.

type Protocol = FDomainMarker

The protocol.

fn from_client(value: ClientEnd<FDomainMarker>) -> Self

Converts from a client.

impl SynchronousProxy for FDomainSynchronousProxy

Available on Fuchsia only.

type Proxy = FDomainProxy

The async proxy for the same protocol.

type Protocol = FDomainMarker

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.