Struct AddressStateProviderSynchronousProxy

pub struct AddressStateProviderSynchronousProxy { /* private fields */ }

Implementations

impl AddressStateProviderSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<AddressStateProviderEvent, 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 update_address_properties( &self, address_properties: &AddressProperties, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Push an update when the address properties change.

The client pushes updates on address properties changes, such as the address becoming deprecated, or the preferred and valid lifetimes being updated as a result of extending the address’ lifetime. The server is expected to cache address properties.

If address_properties contains invalid property values, the address is removed and [AddressRemovalReason.INVALID_PROPERTIES] is issued.

• request address_properties the updated properties of the address.

pub fn watch_address_assignment_state( &self, ___deadline: MonotonicInstant, ) -> Result<AddressAssignmentState, Error>

Hanging get for address assignment state.

The server does not keep a queue of assignment states, it returns the latest state if it differs from the last one observed.

The first call will always immediately return the current assignment state. Subsequent calls will block until the returned value differs from the last observed value.

It is invalid to call this method while a previous call is pending. Doing so will cause the server end of the protocol to be closed.

• response assignment_state the assignment state of the address.

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

Detaches the address’ lifetime from the client end of the protocol.

The client end of the protocol can be closed immediately after calling this method, and the address will not be removed.

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

Removes the address.

The server end of the protocol is closed after address removal has completed, and the USER_REMOVED OnAddressRemoved event is sent.

Trait Implementations

impl Debug for AddressStateProviderSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for AddressStateProviderSynchronousProxy

type Proxy = AddressStateProviderProxy

The async proxy for the same protocol.

type Protocol = AddressStateProviderMarker

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.