Enum xdg_shell_server_protocol::xdg_wm_base::Event

pub enum Event {
    Ping {
        serial: u32,
    },
}

Variants

Ping

Fields

serial: u32

pass this to the pong request

check if the client is alive

The ping event asks the client if it’s still alive. Pass the serial specified in the event back to the compositor by sending a “pong” request back with the specified serial. See xdg_wm_base.pong.

Compositors can use this to determine if the client is still alive. It’s unspecified what will happen if the client doesn’t respond to the ping request, or in what timeframe. Clients should try to respond in a reasonable amount of time.

A compositor is free to ping in any way it wants, but a client must always respond to any xdg_wm_base object it created.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl IntoMessage for Event

type Error = EncodeError

fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error>

Consumes |self| and serializes into a |Message|.

impl MessageType for Event

fn log(&self, this: ObjectId) -> String

Generates a string suitable for protocol logging this message.

fn message_name(&self) -> &'static CStr

Returns a static CStr reference that describes the interface/method of this message.