event-loop.h File Reference

Module responsible for running enqueued events and process them accordingly. More...

#include "uevloop/utils/closure.h"
#include "uevloop/utils/linked-list.h"
#include "uevloop/system/containers/system-pools.h"
#include "uevloop/system/containers/system-queues.h"

Include dependency graph for event-loop.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	uel_evloop_t
	The event loop object. More...

Functions
void	uel_evloop_init (uel_evloop_t *event_loop, uel_syspools_t *pools, uel_sysqueues_t *queues)
	Initialises an event loop. More...
void	uel_evloop_run (uel_evloop_t *event_loop)
	Triggers a runloop. More...
void	uel_evloop_enqueue_closure (uel_evloop_t *event_loop, uel_closure_t *closure, void *value)
	Enqueues a closure to be invoked. More...
uel_event_t *	uel_evloop_observe (uel_evloop_t *event_loop, volatile uintptr_t *condition_var, uel_closure_t *closure)
	Observes a value and reacts to changes in it. More...
uel_event_t *	uel_evloop_observe_once (uel_evloop_t *event_loop, volatile uintptr_t *condition_var, uel_closure_t *closure)
	Observes a value and reacts once to changes in it. Afterwards, the observer will be destroyed. More...

Detailed Description

Module responsible for running enqueued events and process them accordingly.

Function Documentation

uel_evloop_enqueue_closure()

void uel_evloop_enqueue_closure	(	uel_evloop_t *	event_loop,
		uel_closure_t *	closure,
		void *	value
	)

Enqueues a closure to be invoked.

Parameters

event_loop	The uel_evloop_t instance into which the closure will be enqueued
closure	The closure to be enqueued
value	The value to invoked the closure with

uel_evloop_init()

void uel_evloop_init	(	uel_evloop_t *	event_loop,
		uel_syspools_t *	pools,
		uel_sysqueues_t *	queues
	)

Initialises an event loop.

Parameters

event_loop	The uel_evloop_t instance to be initialised
pools	The system's internal pools
queues	The system's internal queues

uel_evloop_observe()

uel_event_t* uel_evloop_observe	(	uel_evloop_t *	event_loop,
		volatile uintptr_t *	condition_var,
		uel_closure_t *	closure
	)

Observes a value and reacts to changes in it.

Parameters

event_loop	The event loop where to register this observer
condition_var	The address of some data that should be observed
closure	The closure to be invoked when the observed value changes

Returns

The observer event representing this observation operation

uel_evloop_observe_once()

uel_event_t* uel_evloop_observe_once	(	uel_evloop_t *	event_loop,
		volatile uintptr_t *	condition_var,
		uel_closure_t *	closure
	)

Observes a value and reacts once to changes in it. Afterwards, the observer will be destroyed.

Parameters

event_loop	The event loop where to register this observer
condition_var	The address of some data that should be observed
closure	The closure to be invoked when the observed value changes

Returns

The observer event representing this observation operation

uel_evloop_run()

void uel_evloop_run

(

uel_evloop_t *

event_loop

)

Triggers a runloop.

This function flushes the event queue and processes each event in it. Afterwards, depending on the event type, it disposes of the event in different ways.

Each iteration of this cycle is called a runloop.

Parameters

event_loop

The uel_evloop_t instance to be run