Struct ProviderSynchronousProxy

pub struct ProviderSynchronousProxy { /* private fields */ }

Implementations

impl ProviderSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ProviderEvent, 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 create_view( &self, a11y_view_token: ViewCreationToken, proxy_viewport_token: ViewportCreationToken, ) -> Result<(), Error>

Prompts the server (a11y manager) to create a new accessibility View, which the client (scene manager) must connect to the root of the scene graph.

The accessibility view is used to vend capabilities to a11y manager that a view confers, e.g. ability to request focus, consume and respond to input events, annotate underlying views, and apply coordinate transforms to its subtree.

With the a11y view, the scene topology is roughly:

     scene root (owned by scene manager)
          |
    a11y viewport (owned by scene manager)
          |
      a11y view (owned by a11y manager)
          |
   proxy viewport (owned by a11y manager)
          |
     proxy view (owned by scene manager)
          |
   client viewport (owned by scene manager)
          |
     client view (owned by UI client)

ARGS

a11y_view_token: Token generated by scene manager, which a11y manager uses to create the a11y view in its flatland instance.

proxy_viewport_token: Token generated by scene manager, which a11y manager uses to create a “proxy viewport” within the a11y view. The client must subsequently create a “proxy view” using the corresponding view creation token it generated.

SYNCHRONIZATION

Callers may safely proceed once the accessibility ViewRef is returned to the accessibility ViewPort holder.

LIFECYCLE

The client is free to close the channel any time after calling CreateView().

EPITAPH

This method may return the following epitaphs:

• ZX_ERR_INVALID_ARGS, if either of the provided tokens is invalid.
• ZX_ERR_PEER_CLOSED, if Scenic fails creating the accessibility Viewport.

Trait Implementations

impl Debug for ProviderSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ProviderSynchronousProxy

type Proxy = ProviderProxy

The async proxy for the same protocol.

type Protocol = ProviderMarker

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.