wayland::callback_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

🌸 NAME 🌸

wayland::callback_t — the callback object, bestie ✨

🦋 SYNOPSIS 🦋

#include <wayland-client-protocol.hpp>

Inherits wayland::proxy_t. That's its whole lineage, no cap 💅

🎀 Public Types 🎀

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the four flavors of proxy-wrapper energy, explained in full down below 👑

🫶 Public Member Functions 🫶

  • std::function< void(uint32_t)> & on_done () — the done event, aka the "we're so back" notification
  • uint32_t get_id () const — grab the id of a proxy object
  • std::string get_class () const — grab the interface name (class) of a proxy object
  • uint32_t get_version () const — grab the protocol object version of a proxy object
  • wrapper_type get_wrapper_type () const — find out what type of proxy object this is
  • void set_queue (event_queue_t queue) — assign a proxy to an event queue
  • wl_proxy * c_ptr () const — get a pointer to the underlying C struct
  • bool proxy_has_object () const — check whether this wrapper actually wraps an object
  • operator bool () const — same vibe check, but bool-flavored
  • bool operator== (const proxy_t &right) const — check whether two wrappers refer to the same object
  • bool operator!= (const proxy_t &right) const — check whether two wrappers refer to different objects
  • void proxy_release () — release the wrapped object (if there is one), leaving you with an empty wrapper

💜 DETAILED DESCRIPTION 💜

callback_t is a callback object, periodt.

Clients can handle the 'done' event to get notified when the related request is done. That's literally the entire personality, and honestly? Iconic. 🔥

Examples: egl.cpp.

Definition at line 212 of file wayland-client-protocol.hpp.

👑 MEMBER ENUMERATION DOCUMENTATION 👑

enum class wayland::proxy_t::wrapper_type [strong], [inherited]

This enum tells you the underlying wl_proxy type and the properties of a proxy_t that affect construction, destruction, and event handling. Basically the astrology of proxies 🌈

Enumerator:

  • standard — the C pointer is a standard type compatible with wl_proxy*. Events are dispatched and it is destructed when the proxy_t is destructed. User data is set.
  • display — the C pointer is a wl_display*. No events are dispatched, wl_display_disconnect is called when the proxy_t is destructed. User data is set.
  • foreign — the C pointer is a standard type compatible with wl_proxy*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl_proxy_destroy is not called when the proxy_t is destructed, user data is not touched. Consequently, there is no reference counting for the proxy_t. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy. 🫣 (hands off, it's not yours!!)
  • proxy_wrapper — the C pointer is a wl_proxy* that was constructed with wl_proxy_create_wrapper. No events are dispatched, wl_proxy_wrapper_destroy is called when the proxy_t is destroyed. Reference counting is active. A reference to the proxy_t creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.

Definition at line 117 of file wayland-client.hpp.

✨ MEMBER FUNCTION DOCUMENTATION ✨

wl_proxy * wayland::proxy_t::c_ptr () const [inherited]

Get a pointer to the underlying C struct.

Returns: the underlying wl_proxy wrapped by this proxy_t if it exists — otherwise an exception is thrown 😭 (so maybe don't be surprised-pikachu when it throws)

std::string wayland::proxy_t::get_class () const [inherited]

Get the interface name (class) of a proxy object.

Returns: the interface name of the object associated with the proxy

uint32_t wayland::proxy_t::get_id () const [inherited]

Get the id of a proxy object.

Returns: the id of the object associated with the proxy

uint32_t wayland::proxy_t::get_version () const [inherited]

Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API.

A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version. ⚠️ no vibes-based guessing, make safe assumptions.

display_t will always return version 0.

Returns: the protocol object version of the proxy or 0

wrapper_type wayland::proxy_t::get_wrapper_type () const [inline], [inherited]

Get the type of a proxy object.

Definition at line 303 of file wayland-client.hpp.

std::function< void(uint32_t)> & callback_t::on_done ()

The done event 🎉

Parameters: callback_data — request-specific data for the callback

Notify the client when the related request is done. That's the whole thing. You get pinged, you move on, slay.

Definition at line 1680 of file wayland-client-protocol.cpp.

wayland::proxy_t::operator bool () const [inherited]

Check whether this wrapper actually wraps an object.

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

bool wayland::proxy_t::operator!= (const proxy_t & right) const [inherited]

Check whether two wrappers refer to different objects.

bool wayland::proxy_t::operator== (const proxy_t & right) const [inherited]

Check whether two wrappers refer to the same object.

bool wayland::proxy_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

void wayland::proxy_t::proxy_release () [inherited]

Release the wrapped object (if any), making this an empty wrapper. Note that display_t instances cannot be released this way. Attempts to do so are ignored. 💀 (it's giving "I'm not doing that and you can't make me")

Examples: foreign_display.cpp.

void wayland::proxy_t::set_queue (event_queue_t queue) [inherited]

Assign a proxy to an event queue.

Parameters: queue — the event queue that will handle this proxy

Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.

See also: display_t::dispatch_queue().

Examples: proxy_wrapper.cpp.

🌟 Author 🌟

Generated automatically by Doxygen for Wayland++ from the source code. (Not a human, just very efficient 💅)

Ok that's the whole page, bestie — auto-generated by Doxygen for Wayland++ 🧚, Version 1.0.1, dated Fri Mar 27 2026 13:15:00. Go forth and let your callbacks tell you when things are done 🫶✨

📦 where this page comes from