wayland_server_callback_t - Man Page

callback object

Synopsis

#include <wayland-server-protocol.hpp>

Inherits wayland::server::resource_t.

void done (uint32_t callback_data, bool post=true)
done event
bool proxy_has_object () const
Check whether this wrapper actually wraps an object.
void post_no_memory () const
uint32_t get_id () const
client_t get_client () const
unsigned int get_version () const
std::string get_class ()

Static Public Attributes

static constexpr std::uint32_t done_since_version = 1
Minimum protocol version required for the done function.

Detailed Description

callback object

Clients can handle the 'done' event to get notified when the related request is done.

Definition at line 220 of file wayland-server-protocol.hpp.

Member Function Documentation

void callback_t::done (uint32_t callback_data, bool post = true)

done event

Parameters: callback_data request-specific data for the callback

Notify the client when the related request is done.

Definition at line 1617 of file wayland-server-protocol.cpp.

std::string wayland::server::resource_t::get_class () [inherited]

Retrieve the interface name (class) of a resource object.

Returns: Interface name of the resource object.

client_t wayland::server::resource_t::get_client () const [inherited]

Get the associated client

Returns: the client that owns the resource.

uint32_t wayland::server::resource_t::get_id () const [inherited]

Get the internal ID of the resource

Returns: the internal ID of the resource

unsigned int wayland::server::resource_t::get_version () const [inherited]

Get interface version

Returns: Interface version this resource has been constructed with.

void wayland::server::resource_t::post_no_memory () const [inherited]

Post 'not enough memory' error to the client

If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance.

bool wayland::server::resource_t::proxy_has_object () const [inherited]

Check whether this wrapper actually wraps an object.

Returns: true if there is an underlying object, false if this wrapper is empty