Struct PortProxy 

pub struct PortProxy { /* private fields */ }

Implementations

impl PortProxy

pub fn new(channel: Channel) -> 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, FDomainResourceDialect>

Obtain information about port.

• response info port information.

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

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, FDomainResourceDialect>

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.

pub fn get_identity(&self) -> QueryResponseFut<Event, FDomainResourceDialect>

Retrieves a unique event handle that is always associated only with this port.

This event may be used to uniquely identify a specific port instance across different APIs in the system.

pub fn get_power_dependency_token( &self, ) -> QueryResponseFut<Option<Event>, FDomainResourceDialect>

Gets the Power Broker dependency token for this port’s power element.

The token exposes two levels: 0 (off) and 1 (on). Clients lease level 1 whenever the port’s datapath is required and hold the lease for as long as it is required. Drivers are free to internally power-manage a leased-but-idle port so long as it’s invisible to upper layers.

The token is fixed for the lifetime of the port.

• response token absent if this port does not participate in power management.

Trait Implementations

impl Clone for PortProxy

fn clone(&self) -> Self

Returns a duplicate 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, FDomainResourceDialect>

type GetStatusResponseFut = QueryResponseFut<PortStatus, FDomainResourceDialect>

type GetCountersResponseFut = QueryResponseFut<PortGetCountersResponse, FDomainResourceDialect>

type GetIdentityResponseFut = QueryResponseFut<Event, FDomainResourceDialect>

type GetPowerDependencyTokenResponseFut = QueryResponseFut<Option<Event>, FDomainResourceDialect>

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>

fn get_identity(&self) -> Self::GetIdentityResponseFut

fn get_power_dependency_token(&self) -> Self::GetPowerDependencyTokenResponseFut

impl Proxy for PortProxy

type Protocol = PortMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

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

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

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 domain(&self) -> Arc<Client>

Get the client supporting this proxy. We call this a “domain” here because:

fn on_closed(&self) -> OnFDomainSignals

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