Files
wireplumber/lib/wp/event-hook.h
George Kiagiadakis b100bdda4a event-hook: remove the exec type property & enumeration
With the latest changes, we can implement the "after-events" type
with external code that pushes a very low priority event that is
the "rescan" event.
2023-04-17 07:48:18 -04:00

140 lines
3.6 KiB
C

/* WirePlumber
*
* Copyright © 2022 Collabora Ltd.
* @author George Kiagiadakis <george.kiagiadakis@collabora.com>
*
* SPDX-License-Identifier: MIT
*/
#ifndef __WIREPLUMBER_EVENT_HOOK_H__
#define __WIREPLUMBER_EVENT_HOOK_H__
#include "properties.h"
#include "object-interest.h"
G_BEGIN_DECLS
typedef struct _WpEvent WpEvent;
typedef struct _WpEventDispatcher WpEventDispatcher;
typedef enum {
WP_EVENT_HOOK_PRIORITY_LOWEST = -500,
WP_EVENT_HOOK_PRIORITY_ULTRA_LOW = -300,
WP_EVENT_HOOK_PRIORITY_VERY_LOW = -200,
WP_EVENT_HOOK_PRIORITY_LOW = -100,
WP_EVENT_HOOK_PRIORITY_NORMAL = 0,
WP_EVENT_HOOK_PRIORITY_HIGH = 100,
WP_EVENT_HOOK_PRIORITY_VERY_HIGH = 200,
WP_EVENT_HOOK_PRIORITY_ULTRA_HIGH = 300,
WP_EVENT_HOOK_PRIORITY_HIGHEST = 500,
} WpEventHookPriority;
/*! \defgroup wpeventhook WpEventHook */
/*!
* \struct WpEventHook
*
* The event hook is a structure that describes some executable action
* that an event dispatcher will run when a matching event has been received.
*/
#define WP_TYPE_EVENT_HOOK (wp_event_hook_get_type ())
WP_API
G_DECLARE_DERIVABLE_TYPE (WpEventHook, wp_event_hook, WP, EVENT_HOOK, GObject)
struct _WpEventHookClass
{
GObjectClass parent_class;
gboolean (*runs_for_event) (WpEventHook * self, WpEvent * event);
void (*run) (WpEventHook * self, WpEvent * event, GCancellable * cancellable,
GAsyncReadyCallback callback, gpointer callback_data);
gboolean (*finish) (WpEventHook * self, GAsyncResult * res, GError ** error);
/*< private >*/
WP_PADDING(5)
};
WP_API
gint wp_event_hook_get_priority (WpEventHook * self);
WP_API
const gchar * wp_event_hook_get_name (WpEventHook * self);
WP_PRIVATE_API
WpEventDispatcher * wp_event_hook_get_dispatcher (WpEventHook * self);
WP_PRIVATE_API
void wp_event_hook_set_dispatcher (WpEventHook * self,
WpEventDispatcher * dispatcher);
WP_API
gboolean wp_event_hook_runs_for_event (WpEventHook * self, WpEvent * event);
WP_API
void wp_event_hook_run (WpEventHook * self,
WpEvent * event, GCancellable * cancellable,
GAsyncReadyCallback callback, gpointer callback_data);
WP_API
gboolean wp_event_hook_finish (WpEventHook * self, GAsyncResult * res,
GError ** error);
/*!
* \brief The WpInterestEventHook GType
* \ingroup wpeventhook
*/
#define WP_TYPE_INTEREST_EVENT_HOOK (wp_interest_event_hook_get_type ())
WP_API
G_DECLARE_DERIVABLE_TYPE (WpInterestEventHook, wp_interest_event_hook,
WP, INTEREST_EVENT_HOOK, WpEventHook)
struct _WpInterestEventHookClass
{
WpEventHookClass parent_class;
/*< private >*/
WP_PADDING(4)
};
WP_API
void wp_interest_event_hook_add_interest (WpInterestEventHook * self,
...) G_GNUC_NULL_TERMINATED;
WP_API
void wp_interest_event_hook_add_interest_full (WpInterestEventHook * self,
WpObjectInterest * interest);
/*!
* \brief The WpSimpleEventHook GType
* \ingroup wpeventhook
*/
#define WP_TYPE_SIMPLE_EVENT_HOOK (wp_simple_event_hook_get_type ())
WP_API
G_DECLARE_FINAL_TYPE (WpSimpleEventHook, wp_simple_event_hook,
WP, SIMPLE_EVENT_HOOK, WpInterestEventHook)
WP_API
WpEventHook * wp_simple_event_hook_new (const gchar *name, gint priority,
GClosure * closure);
/*!
* \brief The WpAsyncEventHook GType
* \ingroup wpeventhook
*/
#define WP_TYPE_ASYNC_EVENT_HOOK (wp_async_event_hook_get_type ())
WP_API
G_DECLARE_FINAL_TYPE (WpAsyncEventHook, wp_async_event_hook,
WP, ASYNC_EVENT_HOOK, WpInterestEventHook)
WP_API
WpEventHook * wp_async_event_hook_new (const gchar *name, gint priority,
GClosure * get_next_step, GClosure * execute_step);
G_END_DECLS
#endif