Struct wayland_server::backend::Backend

pub struct Backend<D>
where
    D: 'static,
{ /* private fields */ }

A backend object that represents the state of a wayland server.

A backend is used to drive a wayland server by receiving requests, dispatching messages to the appropriate handlers and flushes requests to be sent back to the client.

Implementations

impl<D> Backend<D>

pub fn new() -> Result<Backend<D>, InitError>

Initialize a new Wayland backend

pub fn flush(&mut self, client: Option<ClientId>) -> Result<(), Error>

Flushes pending events destined for a client.

If no client is specified, all pending events are flushed to all clients.

pub fn handle(&self) -> Handle

Returns a handle which represents the server side state of the backend.

The handle provides a variety of functionality, such as querying information about wayland objects, obtaining data associated with a client and it’s objects, and creating globals.

pub fn poll_fd(&self) -> BorrowedFd<'_>

Returns the underlying file descriptor.

The file descriptor may be monitored for activity with a polling mechanism such as epoll or kqueue. When it becomes readable, this means there are pending messages that would be dispatched if you call Backend::dispatch_all_clients.

The file descriptor should not be used for any other purpose than monitoring it.

pub fn dispatch_single_client( &mut self, data: &mut D, client_id: ClientId ) -> Result<usize, Error>

Dispatches all pending messages from the specified client.

This method will not block if there are no pending messages.

The provided data will be provided to the handler of messages received from the client.

For performance reasons, use of this function should be integrated with an event loop, monitoring the file descriptor associated with the client and only calling this method when messages are available.

Note: This functionality is currently only available on the rust backend, invoking this method on the system backend will do the same as invoking Backend::dispatch_all_clients().

pub fn dispatch_all_clients(&mut self, data: &mut D) -> Result<usize, Error>

Dispatches all pending messages from all clients.

This method will not block if there are no pending messages.

The provided data will be provided to the handler of messages received from the clients.

For performance reasons, use of this function should be integrated with an event loop, monitoring the file descriptor retrieved by Backend::poll_fd and only calling this method when messages are available.

Trait Implementations

impl<D> Debug for Backend<D>

where D: Debug + 'static,

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

Formats the value using the given formatter.