Struct DeviceProxy

pub struct DeviceProxy { /* private fields */ }

Implementations

impl DeviceProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.net.tun/Device.

pub fn take_event_stream(&self) -> DeviceEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn write_frame( &self, frame: &Frame, ) -> QueryResponseFut<DeviceWriteFrameResult, DefaultFuchsiaResourceDialect>

Writes a frame to the device (data coming from network-end).

If the device was created with the [fuchsia.net.tun/DeviceConfig.blocking] option set to true, calls to WriteFrame block until there is one buffer available to fulfill the request.

• request frame inbound frame data and metadata.

• error ZX_ERR_NOT_FOUND if [Frame.port] references an unknown port.
• error ZX_ERR_INVALID_ARGS if frame is invalid.
• error ZX_ERR_BAD_STATE if the device is offline.
• error ZX_ERR_BAD_STATE if the device is offline.
• error ZX_ERR_NO_RESOURCES if more than [fuchsia.net.tun/MAX_PENDING_OPERATIONS] calls to WriteFrame are pending.
• error ZX_ERR_SHOULD_WAIT if blocking is set to false and there are no buffers available to fulfill the request.

pub fn read_frame( &self, ) -> QueryResponseFut<DeviceReadFrameResult, DefaultFuchsiaResourceDialect>

Gets the next frame from the device (data coming from host-end).

If the device was created with the [fuchsia.net.tun/DeviceConfig.blocking] option set to true, calls to ReadFrame block until there is a frame available to be read.

• response frame outbound frame data and metadata.

• error ZX_ERR_NO_RESOURCES if more than [fuchsia.net.tun/MAX_PENDING_OPERATIONS] calls to ReadFrame are pending.
• error ZX_ERR_SHOULD_WAIT if blocking is set to false and there are no frames to be read.

pub fn get_signals( &self, ) -> QueryResponseFut<EventPair, DefaultFuchsiaResourceDialect>

Retrieves signals eventpair.

• response signals an eventpair that is signalled with SIGNAL_READABLE and SIGNAL_WRITABLE when read and write buffers are available, respectively.

pub fn add_port( &self, config: &DevicePortConfig, port: ServerEnd<PortMarker>, ) -> Result<(), Error>

Creates a new port on this device.

• request config new port configuration.
• request port grants control over the port. Closed with an epitaph if config is not valid.

pub fn get_device(&self, device: ServerEnd<DeviceMarker>) -> Result<(), Error>

Connects to the underlying device endpoint.

• request device device handle.

pub fn delegate_rx_lease(&self, lease: DelegatedRxLease) -> Result<(), Error>

Delegates an rx lease through the tun device.

See documentation on [fuchsia.hardware.network/DelegatedRxLease] for proper usage.

Trait Implementations

impl Clone for DeviceProxy

fn clone(&self) -> DeviceProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeviceProxy

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

Formats the value using the given formatter.

impl DeviceProxyInterface for DeviceProxy

type WriteFrameResponseFut = QueryResponseFut<Result<(), i32>>

type ReadFrameResponseFut = QueryResponseFut<Result<Frame, i32>>

type GetSignalsResponseFut = QueryResponseFut<EventPair>

fn write_frame(&self, frame: &Frame) -> Self::WriteFrameResponseFut

fn read_frame(&self) -> Self::ReadFrameResponseFut

fn get_signals(&self) -> Self::GetSignalsResponseFut

fn add_port( &self, config: &DevicePortConfig, port: ServerEnd<PortMarker>, ) -> Result<(), Error>

fn get_device(&self, device: ServerEnd<DeviceMarker>) -> Result<(), Error>

fn delegate_rx_lease(&self, lease: DelegatedRxLease) -> Result<(), Error>

impl Proxy for DeviceProxy

type Protocol = DeviceMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.