Struct PortProxy

pub struct PortProxy { /* private fields */ }

Implementations

impl PortProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.network/Port.

pub fn take_event_stream(&self) -> PortEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_info( &self, ) -> QueryResponseFut<PortInfo, DefaultFuchsiaResourceDialect>

Obtain information about port.

• response info port information.

pub fn get_status( &self, ) -> QueryResponseFut<PortStatus, DefaultFuchsiaResourceDialect>

Obtain the operating port status.

• response status snapshot of port’s current status.

pub fn get_status_watcher( &self, watcher: ServerEnd<StatusWatcherMarker>, buffer: u32, ) -> Result<(), Error>

Connects to a [StatusWatcher] to observe port status changes.

• request watcher handle to the status watcher.
• request buffer the number of status changes that the client requests to be stored by StatusWatcher. Values are capped at MAX_STATUS_BUFFER. A value of 0 or 1 causes the StatusWatcher to not keep any buffers on status changed. Clients that need to observe all changes to status (as opposed to only the current state) are encouraged to set a buffer value larger than 1, so that all edges can be observed. If StatusWatcher’s internal queue is filled and new status changes occur, the oldest samples will be dropped to make room for new ones.

pub fn get_mac(&self, mac: ServerEnd<MacAddressingMarker>) -> Result<(), Error>

Connects to a [MacAddressing] associated with the port.

• request mac mac handle. Closed with ZX_ERR_NOT_SUPPORTED if this port does not support mac addressing.

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

Connects to the [Device] this port belongs to.

• request device grants access to the parent device.

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

Establishes a new connection to this port.

• request port the server end for the new connection.

pub fn get_counters( &self, ) -> QueryResponseFut<PortGetCountersResponse, DefaultFuchsiaResourceDialect>

Retrieves a snapshot of traffic counters on this port.

pub fn get_diagnostics( &self, diagnostics: ServerEnd<DiagnosticsMarker>, ) -> Result<(), Error>

Grants access to [Diagnostics] for this port.

• request diagnostics grants access to diagnostics information.

Trait Implementations

impl Clone for PortProxy

fn clone(&self) -> PortProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortProxy

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

Formats the value using the given formatter.

impl PortProxyInterface for PortProxy

type GetInfoResponseFut = QueryResponseFut<PortInfo>

type GetStatusResponseFut = QueryResponseFut<PortStatus>

type GetCountersResponseFut = QueryResponseFut<PortGetCountersResponse>

fn get_info(&self) -> Self::GetInfoResponseFut

fn get_status(&self) -> Self::GetStatusResponseFut

fn get_status_watcher( &self, watcher: ServerEnd<StatusWatcherMarker>, buffer: u32, ) -> Result<(), Error>

fn get_mac(&self, mac: ServerEnd<MacAddressingMarker>) -> Result<(), Error>

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

fn clone(&self, port: ServerEnd<PortMarker>) -> Result<(), Error>

fn get_counters(&self) -> Self::GetCountersResponseFut

fn get_diagnostics( &self, diagnostics: ServerEnd<DiagnosticsMarker>, ) -> Result<(), Error>

impl Proxy for PortProxy

type Protocol = PortMarker

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.