Struct CoordinatorListenerProxy

pub struct CoordinatorListenerProxy { /* private fields */ }

Implementations

impl CoordinatorListenerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.display/CoordinatorListener.

pub fn take_event_stream(&self) -> CoordinatorListenerEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn on_displays_changed( &self, added: &[Info], removed: &[DisplayId], ) -> Result<(), Error>

Called when the set of connected displays changes.

Also used to communicate the set of connected displays to a newly connected client.

After this method is called, all applied and draft configurations may no longer be valid. The client must validate and apply a new configuration, by calling [Coordinator.CheckConfig] and [Coordinator.ApplyConfig].

added and removed must not be both empty.

pub fn on_vsync( &self, display_id: &DisplayId, timestamp: i64, applied_config_stamp: &ConfigStamp, cookie: &VsyncAckCookie, ) -> Result<(), Error>

Called on every display Vertical Synchronization (Vsync).

Clients must acknowledge VSync events via the method [Coordinator.AcknowledgeVsync]. The coordinator may throttle a client that accumulates a certain number of unacknowledged VSync cookies. Throttled clients do not receive VSync events.

After a the client catches up on acknowledging cookies, the coordinator will unthrottle it (resume sending VSync events). Throttled clients may miss some VSync events, as the coordinator is allowed to drop VSync event information for throttled clients.

When dropping VSync event information for throttled clients, the coordinator should prioritize retaining the information for newer events. In other words, the oldest unreported events should be dropped first.

pub fn on_client_ownership_change( &self, has_ownership: bool, ) -> Result<(), Error>

Called when the corresponding Coordinator client gains or loses ownership of the displays.

A Coordinator client’s active config is displayed iff it holds the ownership of the displays.

A new Coordinator client should assume they do not have ownership of the displays until this method informs them otherwise.

Trait Implementations

impl Clone for CoordinatorListenerProxy

fn clone(&self) -> CoordinatorListenerProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CoordinatorListenerProxyInterface for CoordinatorListenerProxy

fn on_displays_changed( &self, added: &[Info], removed: &[DisplayId], ) -> Result<(), Error>

fn on_vsync( &self, display_id: &DisplayId, timestamp: i64, applied_config_stamp: &ConfigStamp, cookie: &VsyncAckCookie, ) -> Result<(), Error>

fn on_client_ownership_change(&self, has_ownership: bool) -> Result<(), Error>

impl Debug for CoordinatorListenerProxy

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

Formats the value using the given formatter.

impl Proxy for CoordinatorListenerProxy

type Protocol = CoordinatorListenerMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.