Package org.freedesktop.wayland.server

Interface WlDisplayRequests

public interface WlDisplayRequests

core global object

The core global object. This is a special singleton object. It is used for internal Wayland protocol features.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	getRegistry(WlDisplayResource requester, int registry)	get global registry object
void	sync(WlDisplayResource requester, int callback)	asynchronous roundtrip

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

sync

void sync(WlDisplayResource requester,
 int callback)

asynchronous roundtrip

The sync request asks the server to emit the 'done' event on the returned wl_callback object. Since requests are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous requests and the resulting events have been handled.

The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point.

The callback_data passed in the callback is undefined and should be ignored.

Parameters:

requester - The protocol object that made the request.

callback - callback object for the sync request

getRegistry

void getRegistry(WlDisplayResource requester,
 int registry)

get global registry object

This request creates a registry object that allows the client to list and bind the global objects available from the compositor.

It should be noted that the server side resources consumed in response to a get_registry request can only be released when the client disconnects, not when the client side proxy is destroyed. Therefore, clients should invoke get_registry as infrequently as possible to avoid wasting memory.

Parameters:

requester - The protocol object that made the request.

registry - global registry object