Struct ControlSynchronousProxy

pub struct ControlSynchronousProxy { /* private fields */ }

Implementations

impl ControlSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ControlEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn add_address( &self, address: &Subnet, parameters: &AddressParameters, address_state_provider: ServerEnd<AddressStateProviderMarker>, ) -> Result<(), Error>

Assigns an address to the interface.

Errors are communicated via [fuchsia.net.interfaces.admin/AddressStateProvider.OnAddressRemoved].

• request address the address to assign to the interface.
• request parameters additional address-specific options.
• request address_state_provider provides address assignment state and enables updating address properties.

pub fn remove_address( &self, address: &Subnet, ___deadline: MonotonicInstant, ) -> Result<ControlRemoveAddressResult, Error>

Removes an address from the interface.

• request address the address to remove.

• response did_remove true iff address was removed from the interface as a consequence of this call.

pub fn get_id(&self, ___deadline: MonotonicInstant) -> Result<u64, Error>

Gets the interface identifier.

• response id the interface identifier.

pub fn set_configuration( &self, config: &Configuration, ___deadline: MonotonicInstant, ) -> Result<ControlSetConfigurationResult, Error>

Sets the configuration for the interface.

Only set fields that are supported in the provided Configuration will be set; unset fields will be left unmodified. The server will return a Configuration which holds the previous configuration for fields that the interface supports and set, even if the call did not update the configuration’s value.

• request config the configuration fields to update on the interface.

• response previous_config a snapshot of the interface’s previous configuration. Only supported fields present in config will be set.

pub fn get_configuration( &self, ___deadline: MonotonicInstant, ) -> Result<ControlGetConfigurationResult, Error>

Gets a snapshot of the interface’s configuration.

The server will populate the returned Configuration with the configuration for features/protocols that the interface supports. That is, fields for unsupported configurations will be unset in the returned Configuration.

• response config a snapshot of the interface’s configuration.

pub fn enable( &self, ___deadline: MonotonicInstant, ) -> Result<ControlEnableResult, Error>

Enables the interface.

• response did_enable true iff the interface moved from disabled to enabled as a consequence of this call.

pub fn disable( &self, ___deadline: MonotonicInstant, ) -> Result<ControlDisableResult, Error>

Disables the interface.

• response did_disable true iff the interface moved from enabled to disabled as a consequence of this call.

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

Detaches the client end from the interface’s lifetime.

After calling Detach, closing this client end no longer causes the interface to be removed.

pub fn get_authorization_for_interface( &self, ___deadline: MonotonicInstant, ) -> Result<GrantForInterfaceAuthorization, Error>

Get an authentication credential for this interface.

The credential contains a [zx::handle::EVENT], whose entangled partner is held by the server. This credential can be converted into a ProofOfInterfaceAuthorization and then passed into fuchsia.net.* API calls to prove ownership of this interface. The EVENT is stable throughout the lifetime of the interface. Clients may duplicate this EVENT to make multiple API calls, or transfer the EVENT to other clients.

• response credential the authorization credential for this interface.

pub fn remove( &self, ___deadline: MonotonicInstant, ) -> Result<ControlRemoveResult, Error>

Initiates interface removal.

This method returns success once interface removal has started. When the interface is removed, a USER removed reason is issued in [OnInterfaceRemoved] and the server end is closed.

Trait Implementations

impl Debug for ControlSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ControlSynchronousProxy

type Proxy = ControlProxy

The async proxy for the same protocol.

type Protocol = ControlMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.