class Control

class Control

Defined at line 6221 of file fidling/gen/sdk/fidl/fuchsia.net.interfaces.admin/fuchsia.net.interfaces.admin/hlcpp/fuchsia/net/interfaces/admin/cpp/fidl.h

Provides control over an interface.

This protocol encodes the underlying interface's lifetime in both

directions; the interface exists iff both ends of the protocol are open.

That is:

- Closing the client end causes the interface to be removed.

- Observing a closure of the server end indicates the interface no longer

exists.

Public Methods

void ~Control ()
void AddAddress (::fuchsia::net::Subnet address, ::fuchsia::net::interfaces::admin::AddressParameters parameters, ::fidl::InterfaceRequest< ::fuchsia::net::interfaces::admin::AddressStateProvider> address_state_provider)

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.

void RemoveAddress (::fuchsia::net::Subnet address, RemoveAddressCallback callback)

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.

void GetId (GetIdCallback callback)

Gets the interface identifier.

- response `id` the interface identifier.

void SetConfiguration (::fuchsia::net::interfaces::admin::Configuration config, SetConfigurationCallback callback)

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.

void GetConfiguration (GetConfigurationCallback callback)

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.

void Enable (EnableCallback callback)

Enables the interface.

- response `did_enable` `true` iff the interface moved from disabled to

enabled as a consequence of this call.

void Disable (DisableCallback callback)

Disables the interface.

- response `did_disable` `true` iff the interface moved from enabled to

disabled as a consequence of this call.

void Detach ()

Detaches the client end from the interface's lifetime.

After calling `Detach`, closing this client end no longer causes the

interface to be removed.

void GetAuthorizationForInterface (GetAuthorizationForInterfaceCallback callback)

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

[`fuchsia.net.resources/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.

void Remove (RemoveCallback callback)

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.