event.h File Reference

Event function definitions. More...

#include "qsccommon.h"
#include "async.h"
#include <stdarg.h>

Go to the source code of this file.

Data Structures
struct	qsc_event_handler
	The event handler structure. More...
struct	event_state
	The event state context. More...

Macros
#define	QSC_EVENT_NAME_SIZE   32UL
	The character length of the event name.
#define	QSC_EVENT_MAX_LISTENERS   16384
	The maximum number of event listeners.

Typedefs
typedef void(*	qsc_event_callback) (size_t,...)
	The event callback variadic prototype.
typedef QSC_EXPORT_API struct qsc_event_handler	qsc_event_handler
typedef QSC_EXPORT_API struct event_state	event_state

Functions
QSC_EXPORT_API void	qsc_event_clear_listener (event_state *ctx, const char name[QSC_EVENT_NAME_SIZE])
	Clear a listener for a specified event.
QSC_EXPORT_API qsc_event_callback	qsc_event_get_callback (event_state *ctx, const char name[QSC_EVENT_NAME_SIZE])
	Retrieve a callback function by event name.
QSC_EXPORT_API void	qsc_event_dispose (event_state *ctx)
	Destroy all event listeners.
QSC_EXPORT_API bool	qsc_event_listener_name_exists (const event_state *ctx, const char name[QSC_EVENT_NAME_SIZE])
	Initialize the event state.
QSC_EXPORT_API void	qsc_event_initialize (event_state *ctx)
	Initialize the event state.
QSC_EXPORT_API int32_t	qsc_event_register (event_state *ctx, const char name[QSC_EVENT_NAME_SIZE], qsc_event_callback callback)
	Register an event and its callback.

Detailed Description

Event function definitions.

This file defines the API for registering, retrieving, and clearing event callbacks. It supports grouping events by name and provides search hints for advanced documentation navigation. Functions in this module allow for dynamic management of event listeners, making it easier to integrate event-driven programming features into applications.

// Example usage:
// Register an event callback for "my_event"
qsc_event_register("my_event", my_callback_function);

Reference Links:

• Microsoft Event Objects Documentation
• Linux epoll Event Handling

Typedef Documentation

qsc_event_callback

typedef void(* qsc_event_callback) (size_t,...)

The event callback variadic prototype.

This callback function takes a size_t indicating the number of arguments, followed by a variable list of arguments.

See also

qsc_event_handler

Function Documentation

qsc_event_clear_listener()

QSC_EXPORT_API void qsc_event_clear_listener	(	event_state *	ctx,
		const char	name[QSC_EVENT_NAME_SIZE] )

Clear a listener for a specified event.

Clears the listener associated with the specified event name.

Parameters

ctx	The event handler context.
name	[const char[QSC_EVENT_NAME_SIZE]] The name of the event.

qsc_event_dispose()

QSC_EXPORT_API void qsc_event_dispose

(

event_state *

ctx

)

Destroy all event listeners.

Destroys the event handler state and frees all associated resources.

qsc_event_get_callback()

QSC_EXPORT_API qsc_event_callback qsc_event_get_callback	(	event_state *	ctx,
		const char	name[QSC_EVENT_NAME_SIZE] )

Retrieve a callback function by event name.

Retrieves the callback function registered with the specified event name.

Parameters

ctx	The event handler context.
name	[const char[QSC_EVENT_NAME_SIZE]] The name of the event.

Returns

[qsc_event_callback] Returns the callback function if found.

See also

qsc_event_register()

qsc_event_initialize()

QSC_EXPORT_API void qsc_event_initialize

(

event_state *

ctx

)

Initialize the event state.

Destroys the event handler state and frees all associated resources.

Parameters

ctx	The event handler context.

qsc_event_listener_name_exists()

QSC_EXPORT_API bool qsc_event_listener_name_exists	(	const event_state *	ctx,
		const char	name[QSC_EVENT_NAME_SIZE] )

Initialize the event state.

Destroys the event handler state and frees all associated resources.

Parameters

ctx	[const] The event handler context.
name	The event handler string name.

qsc_event_register()

QSC_EXPORT_API int32_t qsc_event_register	(	event_state *	ctx,
		const char	name[QSC_EVENT_NAME_SIZE],
		qsc_event_callback	callback )

Register an event and its callback.

Registers an event with the specified name and callback function.

Parameters

ctx	The event handler context.
name	[const char[QSC_EVENT_NAME_SIZE]] The name of the event.
callback	[qsc_event_callback] The callback function.

Returns

[int32_t] Returns 0 for success.

See also

qsc_event_clear_listener(), qsc_event_get_callback()