Struct RegistrySynchronousProxy

pub struct RegistrySynchronousProxy { /* private fields */ }

Implementations

impl RegistrySynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<RegistryEvent, 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 register_scoped_view_tree_watcher( &self, context_view: u64, watcher: ServerEnd<ViewTreeWatcherMarker>, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Sets up a geometry ViewTreeWatcher channel which reports the view tree geometry for a specific view, identified by context_view. The data received describes the context_view and its descendant views.

This method may be called multiple times to obtain multiple geometry ViewTreeWatchers. Typical usage is to obtain just one geometry ViewTreeWatcher.

Client can freely disconnect this Registry endpoint after this method returns and the ViewTreeWatcher endpoint will remain active.

Flow control. The caller is allowed at most one in-flight call at a time. Subsequent calls must wait until the acknowledgment returns. Non-compliance results in channel closure.

Client synchronization. The method response signifies that the server has processed the channel endpoint. A client can synchronize its next actions based on this guarantee (for example, trigger a change in view geometry without the change “getting lost”).

View lifecycle. The view represented by context_view must first be created. Otherwise, geometry channel’s server endpoint is closed.

• request context_view a view’s identity, which serves as the root of a view tree
• request geometry a channel to observe context_view’s view tree

• response acknowledgement that geometry is connected to the server

Trait Implementations

impl Debug for RegistrySynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for RegistrySynchronousProxy

type Proxy = RegistryProxy

The async proxy for the same protocol.

type Protocol = RegistryMarker

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.