Enum DeviceRequest

pub enum DeviceRequest {
    WriteFrame {
        frame: Frame,
        responder: DeviceWriteFrameResponder,
    },
    ReadFrame {
        responder: DeviceReadFrameResponder,
    },
    GetSignals {
        responder: DeviceGetSignalsResponder,
    },
    AddPort {
        config: DevicePortConfig,
        port: ServerEnd<PortMarker>,
        control_handle: DeviceControlHandle,
    },
    GetDevice {
        device: ServerEnd<DeviceMarker>,
        control_handle: DeviceControlHandle,
    },
    DelegateRxLease {
        lease: DelegatedRxLease,
        control_handle: DeviceControlHandle,
    },
}

Provides control over the created device.

This protocol encodes the underlying object’s lifetime in both directions; the underlying object is alive iff both ends of the protocol are open. That is:

• Closing the client end causes the object to be destroyed.
• Observing a closure of the server end indicates the object no longer exists.

Variants

WriteFrame

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.

Fields

frame: Frame

responder: DeviceWriteFrameResponder

ReadFrame

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.

Fields

responder: DeviceReadFrameResponder

GetSignals

Retrieves signals eventpair.

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

Fields

responder: DeviceGetSignalsResponder

AddPort

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.

Fields

config: DevicePortConfig

port: ServerEnd<PortMarker>

control_handle: DeviceControlHandle

GetDevice

Connects to the underlying device endpoint.

• request device device handle.

Fields

device: ServerEnd<DeviceMarker>

control_handle: DeviceControlHandle

DelegateRxLease

Delegates an rx lease through the tun device.

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

Fields

lease: DelegatedRxLease

control_handle: DeviceControlHandle

Implementations

impl DeviceRequest

pub fn into_write_frame(self) -> Option<(Frame, DeviceWriteFrameResponder)>

pub fn into_read_frame(self) -> Option<DeviceReadFrameResponder>

pub fn into_get_signals(self) -> Option<DeviceGetSignalsResponder>

pub fn into_add_port( self, ) -> Option<(DevicePortConfig, ServerEnd<PortMarker>, DeviceControlHandle)>

pub fn into_get_device( self, ) -> Option<(ServerEnd<DeviceMarker>, DeviceControlHandle)>

pub fn into_delegate_rx_lease( self, ) -> Option<(DelegatedRxLease, DeviceControlHandle)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for DeviceRequest

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

Formats the value using the given formatter.