wlsignal(3) Wayland wlsignal(3)

NAME
       wlsignal -

       A source of a type of observable event.


SYNOPSIS
       #include 

   Public Member Functions
       static void wlsignalinit (struct wlsignal *signal)
       static void wlsignaladd (struct wlsignal *signal, struct wllistener
           *listener)
       static struct wllistener * wlsignalget (struct wlsignal *signal,
           wlnotifyfunct notify)
       static void wlsignalemit (struct wlsignal *signal, void *data)

   Data Fields
       struct wllist listenerlist

Detailed Description
       A source of a type of observable event.

       Signals are recognized points where significant events can be observed.
       Compositors as well as the server can provide signals. Observers are
       wllistener's that are added through wlsignaladd. Signals are emitted
       using wlsignalemit, which will invoke all listeners until that
       listener is removed by wllistremove() (or whenever the signal is
       destroyed).

       See Also:
           wllistener for more information on using wlsignal

Member Function Documentation
   static void wlsignaladd (struct wlsignal *signal, struct wllistener
       *listener) [inline]
       Add the specified listener to this signal.

       Parameters:
           signal The signal that will emit events to the listener
           listener The listener to add

   static void wlsignalemit (struct wlsignal *signal, void *data) [inline]
       Emits this signal, notifying all registered listeners.

       Parameters:
           signal The signal object that will emit the signal
           data The data that will be emitted with the signal

   static struct wllistener * wlsignalget (struct wlsignal *signal,
       wlnotifyfunctnotify)
       Gets the listener struct for the specified callback.

       Parameters:
           signal The signal that contains the specified listener
           notify The listener that is the target of this search

       Returns:
           the list item that corresponds to the specified listener, or NULL
           if none was found

   static void wlsignalinit (struct wlsignal *signal) [inline]
       Initialize a new wlsignal for use.

       Parameters:
           signal The signal that will be initialized

Field Documentation
   struct wllist wlsignal::listenerlist
Author
       Generated automatically by Doxygen for Wayland from the source code.



Version 1.15.0                  Tue Oct 30 2018                   wlsignal(3)