Struct PortProxy

pub struct PortProxy { /* private fields */ }

Implementations

impl PortProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.net.tun/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_state( &self, ) -> QueryResponseFut<InternalState, DefaultFuchsiaResourceDialect>

Gets the port internal state.

• response state a snapshot of the port’s internal state.

pub fn watch_state( &self, ) -> QueryResponseFut<InternalState, DefaultFuchsiaResourceDialect>

Observes changes to internal state.

The first call always returns the current internal state, subsequent calls block until the internal state differs from the last one returned from a WatchState call.

WatchState does not provide full history of internal state changes. It is possible that intermediary internal state changes are missed in between WatchState calls.

• response state the latest observed port internal state.

pub fn set_online( &self, online: bool, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Sets the port’s online status.

The online status is visible through [fuchsia.hardware.network/Port.GetStatus]. Once SetOnline returns, the status reported through GetStatus is guaranteed to be the one passed to SetOnline.

• request online desired port online state.

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

Connects to the underlying device port.

• request port grants access to the device port.

pub fn remove(&self) -> Result<(), Error>

Triggers port removal.

The client end will be closed once the server has completely cleaned up all resources related to the port. This is equivalent to simply dropping the client end, but provides callers with a signal of when removal is complete, allowing port identifiers to be reused, for example.

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 GetStateResponseFut = QueryResponseFut<InternalState>

type WatchStateResponseFut = QueryResponseFut<InternalState>

type SetOnlineResponseFut = QueryResponseFut<()>

fn get_state(&self) -> Self::GetStateResponseFut

fn watch_state(&self) -> Self::WatchStateResponseFut

fn set_online(&self, online: bool) -> Self::SetOnlineResponseFut

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

fn remove(&self) -> 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.