Struct Client 

pub struct Client { /* private fields */ }

A client connected to the proxy.

Clients are usually created by having them connect to an Acceptor. See State::create_acceptor.

Clients can also be created manually with State::connect and State::add_client.

Implementations

impl Client

pub fn set_handler(&self, handler: impl ClientHandler)

Sets a new handler.

pub fn set_boxed_handler(&self, handler: Box<dyn ClientHandler>)

Sets a new, already boxed handler.

pub fn unset_handler(&self)

Unsets the handler.

pub fn objects(&self, objects: &mut Vec<Rc<dyn Object>>)

Returns all objects associated with this client.

This can be used when a client disconnects to perform cleanup in a multi-client proxy.

pub fn display(&self) -> &Rc<WlDisplay>

Returns the wl_display object of this client.

pub fn disconnect(&self)

Disconnects this client.

The ClientHandler::disconnected event is not emitted.

pub fn set_suspended(self: &Rc<Self>, suspended: bool)

Suspends or unsuspends dispatching messages from the client.

Suspending takes effect immediately. That is, if this is called from within a message handler, no further messages from the client will be dispatched until it is unsuspended.

This can be useful in situations where one clients needs to synchronize with another. For example, when a client sends wl_surface.commit and another client needs to take some action before the commit is forwarded to the server.