-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
| Cuel_application_t | Top-level container for µEvLoop'd application |
| Cuel_autopool_t | Automatic pools are wrappers to object pools. They manage the acquisition and release cycle from objects issued at the pool by wrapping them in automatic pointers |
| Cuel_autoptr | Automatic pointers are pointers wrapped by information of where they were issued |
| Cuel_closure_t | Defines a closure, a tuple <function, context, destructor> |
| Cuel_conditional_t | Conditionals are constructs that provide functional flow control |
| Cuel_cqueue_t | Defines a circular queue of void pointers |
| ▼Cuel_event_t | Events are special messages passed around the core. They represent tasks to be run at some point by the system |
| ▼Cuel_event_detail | |
| Cuel_event_listener | Contains the context of a particular signal listener |
| Cuel_event_observer | Contains the reference to an observer variable |
| Cuel_event_signal | Contains information related to an emitted signal |
| Cuel_event_timer | Contains information suitable for scheduling an event at the scheduler |
| Cuel_evloop_t | The event loop object |
| Cuel_func_mapper_t | Maps elements of an iterator to an area of memory. Each element is assigned to a void pointer slot |
| Cuel_iterator_array_t | A specialised iterator suitable for iterating over arrays of arbitrary data |
| Cuel_iterator_t | Iterators are data structures that wrap arbitrary collections of data and define ways of enumerating them |
| Cuel_llist_node_t | Defines a node of the linked list. Holds a void pointer |
| Cuel_llist_t | Defines a linked list. If it is empty, head == tail == NULL. Pushing or popping from both the head or tail is always O(1) |
| Cuel_module_t | A module is an isolated unit of behaviour with lifecycle hooks |
| Cuel_objpool_t | Pre-allocated memory bound to speciffic types suitable for providing dynamic object management in the stack |
| Cuel_pipeline_t | A pipeline is an ordered closure list to be run in sequence |
| Cuel_promise_segment_t | Defines a single synchronous operation to be invoked when the promise is either resolved or rejected |
| Cuel_promise_store_t | An issuer of promises. Contains references to pools for promises and segments |
| Cuel_promise_t | A promise is association of an asynchronous operation to the possible execution paths that follow its resolution. It is also a holder for the value it was settled with |
| Cuel_scheduer_t | The scheduler object |
| Cuel_signal_relay_t | Contains a signal vector and operates on in |
| Cuel_syspools_t | A container for the system pools |
| Cuel_sysqueues_t | A container for the system's internal queues |
- 1.8.17
-
-
-
diff --git a/docs/html/application_8h.html b/docs/html/application_8h.html
deleted file mode 100644
index 3e7b090..0000000
--- a/docs/html/application_8h.html
+++ /dev/null
@@ -1,554 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
The application module is a convenient top-level container for the system internals. -More...
-#include "uevloop/system/containers/system-pools.h"#include "uevloop/system/containers/system-queues.h"#include "uevloop/system/event-loop.h"#include "uevloop/system/scheduler.h"#include "uevloop/system/signal.h"#include "uevloop/utils/module.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_application_t |
| Top-level container for µEvLoop'd application. More... | |
-Typedefs | |
| -typedef enum uel_app_event | uel_app_event_t |
| Alias to the uel_app_event enum. | |
-Enumerations | |
| enum | uel_app_event { UEL_APP_READY = 0, -UEL_APP_CRASHED, -UEL_APP_IDLE, -UEL_APP_EVENT_COUNT - } |
| Events emitted by the application relay. Unused ATM. | |
-Functions | |
| void | uel_app_init (uel_application_t *app) |
| Initialises an uel_application_t instance. More... | |
| void | uel_app_load (uel_application_t *app, uel_module_t **modules, size_t module_count) |
| Loads modules into an application and run their lifecycle hooks. More... | |
| uel_module_t * | uel_app_require (uel_application_t *app, size_t id) |
| Fetches a module from the app's registry. More... | |
| void | uel_app_tick (uel_application_t *app) |
| Ticks the application. More... | |
| void | uel_app_update_timer (uel_application_t *app, uint32_t timer) |
| Updates the internal timer of an application, located at the scheduler. More... | |
| uel_event_t * | uel_app_run_later (uel_application_t *app, uint16_t timeout_in_ms, uel_closure_t closure, void *value) |
| Enqueues a closure for later execution. More... | |
| uel_event_t * | uel_app_run_at_intervals (uel_application_t *app, uint16_t interval_in_ms, bool immediate, uel_closure_t closure, void *value) |
| Enqueues a closure for execution at intervals. More... | |
| void | uel_app_enqueue_closure (uel_application_t *app, uel_closure_t *closure, void *value) |
| Enqueues a closure to be invoked. More... | |
| uel_event_t * | uel_app_observe (uel_application_t *app, volatile uintptr_t *condition_var, uel_closure_t *closure) |
| Sets up an observer. More... | |
The application module is a convenient top-level container for the system internals.
-| void uel_app_enqueue_closure | -( | -uel_application_t * | -app, | -
| - | - | uel_closure_t * | -closure, | -
| - | - | void * | -value | -
| - | ) | -- |
Enqueues a closure to be invoked.
-Proxies the call to uel_evloop_enqueue_closure() with uel_application_t::event_loop as parameter.
-| app | The uel_application_t instance |
| closure | The closure to be enqueued |
| value | The value to invoked the closure with |
| void uel_app_init | -( | -uel_application_t * | -app | ) | -- |
Initialises an uel_application_t instance.
-| app | The uel_application_t instance |
| void uel_app_load | -( | -uel_application_t * | -app, | -
| - | - | uel_module_t ** | -modules, | -
| - | - | size_t | -module_count | -
| - | ) | -- |
Loads modules into an application and run their lifecycle hooks.
-| app | The application onto which to load the modules |
| modules | The modules to be loaded |
| module_count | The number of modules being loaded |
| uel_event_t* uel_app_observe | -( | -uel_application_t * | -app, | -
| - | - | volatile uintptr_t * | -condition_var, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Sets up an observer.
-Proxies the call to uel_evloop_observe() with uel_application_t::event_loop as parameter.
| app | The uel_application_t instance |
| condition_var | The address of the value to be observed |
| closure | The closure to be invoked on change dection |
| uel_module_t* uel_app_require | -( | -uel_application_t * | -app, | -
| - | - | size_t | -id | -
| - | ) | -- |
Fetches a module from the app's registry.
-| app | The application from where to fetch the module |
| id | The module ID to be fetched |
idth position in the registry | uel_event_t* uel_app_run_at_intervals | -( | -uel_application_t * | -app, | -
| - | - | uint16_t | -interval_in_ms, | -
| - | - | bool | -immediate, | -
| - | - | uel_closure_t | -closure, | -
| - | - | void * | -value | -
| - | ) | -- |
Enqueues a closure for execution at intervals.
-Proxies the call to uel_sch_run_at_intervals() with uel_application_t::scheduler as parameter.
-| app | The uel_application_t instance |
| interval_in_ms | The delay in milliseconds two executions of the closure |
| immediate | If this flag is set, the the event will be created with a due time to the current time. |
| closure | The closure to be invoked when the due time is reached |
| value | The value to invoked the closure with |
| uel_event_t* uel_app_run_later | -( | -uel_application_t * | -app, | -
| - | - | uint16_t | -timeout_in_ms, | -
| - | - | uel_closure_t | -closure, | -
| - | - | void * | -value | -
| - | ) | -- |
Enqueues a closure for later execution.
-Proxies the call to uel_sch_run_later() with uel_application_t::scheduler as parameter.
-| app | The uel_application_t instance |
| timeout_in_ms | The delay in milliseconds until the closure is run |
| closure | The closure to be invoked when the due time is reached |
| value | The value to invoked the closure with |
| void uel_app_tick | -( | -uel_application_t * | -app | ) | -- |
Ticks the application.
-Yields control to the application runtime. This will:
| app | The uel_application_t instance |
| void uel_app_update_timer | -( | -uel_application_t * | -app, | -
| - | - | uint32_t | -timer | -
| - | ) | -- |
Updates the internal timer of an application, located at the scheduler.
-| app | The uel_application_t instance |
| timer | The current application timer, in milliseconds |
- 1.8.17
-
-
-
diff --git a/docs/html/application_8h__incl.map b/docs/html/application_8h__incl.map
deleted file mode 100644
index 6822142..0000000
--- a/docs/html/application_8h__incl.map
+++ /dev/null
@@ -1,16 +0,0 @@
-
diff --git a/docs/html/application_8h__incl.md5 b/docs/html/application_8h__incl.md5
deleted file mode 100644
index d2fcc45..0000000
--- a/docs/html/application_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-ee75ab967f4694f782f6fd9e7979ccb6
\ No newline at end of file
diff --git a/docs/html/application_8h__incl.png b/docs/html/application_8h__incl.png
deleted file mode 100644
index e328542..0000000
Binary files a/docs/html/application_8h__incl.png and /dev/null differ
diff --git a/docs/html/application_8h_source.html b/docs/html/application_8h_source.html
deleted file mode 100644
index e4d2c6a..0000000
--- a/docs/html/application_8h_source.html
+++ /dev/null
@@ -1,181 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/automatic-pool_8h.html b/docs/html/automatic-pool_8h.html
deleted file mode 100644
index 75a2a14..0000000
--- a/docs/html/automatic-pool_8h.html
+++ /dev/null
@@ -1,539 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines automatic pointers and automatic pools, objects that wrap object pools and objects managed by them. These wrappers provide basic automatic memory management. -More...
-
Go to the source code of this file.
--Data Structures | |
| struct | uel_autoptr |
| Automatic pointers are pointers wrapped by information of where they were issued. More... | |
| struct | uel_autopool_t |
| Automatic pools are wrappers to object pools. They manage the acquisition and release cycle from objects issued at the pool by wrapping them in automatic pointers. More... | |
-Macros | |
| #define | UEL_DECLARE_AUTOPOOL_BUFFERS(type, size_log2n, id) |
| Declares the necessary buffers to back an automatic pool, so the programmer doesn't have to reason much about it. More... | |
| #define | UEL_AUTOPOOL_BUFFERS(id) (uint8_t *)&id##_buffer, id##_pool_buffer, id##_pool_queue_buffer |
| Refers to a previously declared buffer set. More... | |
| #define | UEL_AUTOPOOL_BUFFERS_IN(id, obj) |
| Refers to a previously declared buffer set. More... | |
| #define | UEL_AUTOPOOL_BUFFERS_AT(id, obj) |
| Refers to a previously declared buffer set. More... | |
-Typedefs | |
| -typedef void ** | uel_autoptr_t |
Aliases uel_autoptr_t to void ** so it can be cast to pointers to other types. | |
-Functions | |
| void | uel_autoptr_dealloc (uel_autoptr_t autoptr) |
| Deallocates an automatic pointer. More... | |
| void | uel_autopool_init (uel_autopool_t *pool, size_t size_log2n, size_t item_size, uint8_t *object_buffer, struct uel_autoptr *autoptr_buffer, void **queue_buffer) |
| Initialises an automatic pool. More... | |
| uel_autoptr_t | uel_autopool_alloc (uel_autopool_t *pool) |
| Allocates an object and wrap it in a automatic pointer. More... | |
| bool | uel_autopool_is_empty (uel_autopool_t *pool) |
| Checks if a pool is depleted. More... | |
| void | uel_autopool_set_constructor (uel_autopool_t *pool, uel_closure_t constructor) |
| Sets the constructor closure of an autopool. More... | |
| void | uel_autopool_set_destructor (uel_autopool_t *pool, uel_closure_t destructor) |
| Sets the destructor closure of an autopool. More... | |
Defines automatic pointers and automatic pools, objects that wrap object pools and objects managed by them. These wrappers provide basic automatic memory management.
-| #define UEL_AUTOPOOL_BUFFERS | -( | -- | id | ) | -(uint8_t *)&id##_buffer, id##_pool_buffer, id##_pool_queue_buffer | -
Refers to a previously declared buffer set.
-This is a convenience macro to supply the buffers generated by UEL_DECLARE_AUTOPOOL_BUFFERS() to the uel_autopool_init() function.
| id | The identifier used to declare the pool buffers |
| #define UEL_AUTOPOOL_BUFFERS_AT | -( | -- | id, | -
| - | - | - | obj | -
| - | ) | -- |
Refers to a previously declared buffer set.
-This is a convenience macro to supply the buffers generated by UEL_DECLARE_AUTOPOOL_BUFFERS() to the uel_autopool_init() function. Use this if the buffers were defined inside an object whose address is accessible in the current scope
| id | The identifier used to declare the pool buffers |
| obj | The address of the object storing the pool buffers |
| #define UEL_AUTOPOOL_BUFFERS_IN | -( | -- | id, | -
| - | - | - | obj | -
| - | ) | -- |
Refers to a previously declared buffer set.
-This is a convenience macro to supply the buffers generated by UEL_DECLARE_AUTOPOOL_BUFFERS() to the uel_autopool_init() function. Use this if the buffers were defined inside a local object, accessible in the current scope.
| id | The identifier used to declare the pool buffers |
| obj | The object storing the pool buffers |
| #define UEL_DECLARE_AUTOPOOL_BUFFERS | -( | -- | type, | -
| - | - | - | size_log2n, | -
| - | - | - | id | -
| - | ) | -- |
Declares the necessary buffers to back an automatic pool, so the programmer doesn't have to reason much about it.
-Use this macro as a shortcut to create the required buffers for an automatic pool. This will declare three buffers in the calling scope.
-| type | The type of the objects the pool will contain |
| size_log2n | The number of elements the pool will contain in log2 form |
| id | A valid identifier for the pools. |
| uel_autoptr_t uel_autopool_alloc | -( | -uel_autopool_t * | -pool | ) | -- |
Allocates an object and wrap it in a automatic pointer.
-The allocated object is submited to the contructor closure set in the autopool.
-| pool | The automatic pool from where to acquire the object |
| void uel_autopool_init | -( | -uel_autopool_t * | -pool, | -
| - | - | size_t | -size_log2n, | -
| - | - | size_t | -item_size, | -
| - | - | uint8_t * | -object_buffer, | -
| - | - | struct uel_autoptr * | -autoptr_buffer, | -
| - | - | void ** | -queue_buffer | -
| - | ) | -- |
Initialises an automatic pool.
-| pool | The pool to be initialised |
| size_log2n | The number of objects in the pool in its log2 form |
| item_size | The size of each object in the pool. If special alignment is required, it must be included in this value. |
| object_buffer | The buffer that contains each object in the pool. Must be 2**size_log2n * item_size long. |
| autoptr_buffer | The buffer that contains each autoptr object to be issued. Must be 2**size_log2n * item_size long. |
| queue_buffer | A void pointer array that will be used as the buffer to the object pointer queue. Must be 2**size_log2n long. |
| bool uel_autopool_is_empty | -( | -uel_autopool_t * | -pool | ) | -- |
Checks if a pool is depleted.
-| pool | The pool to be verified |
| void uel_autopool_set_constructor | -( | -uel_autopool_t * | -pool, | -
| - | - | uel_closure_t | -constructor | -
| - | ) | -- |
Sets the constructor closure of an autopool.
-This closure is invoked when uel_autoptr_alloc() is called and takes a bare pointer to the object being alloc'ed as parameter.
| pool | The autopool onto which to attach the constructor |
| constructor | The constructor closure |
| void uel_autopool_set_destructor | -( | -uel_autopool_t * | -pool, | -
| - | - | uel_closure_t | -destructor | -
| - | ) | -- |
Sets the destructor closure of an autopool.
-This closure is invoked when uel_autoptr_dealloc() is called and takes a bare pointer to the object being dealloc'ed as parameter.
| pool | The autopool onto which to attach the destructor |
| destructor | The destructor closure |
| void uel_autoptr_dealloc | -( | -uel_autoptr_t | -autoptr | ) | -- |
Deallocates an automatic pointer.
-When called, the destructor closure defined at the autopointer's source autopool is invoked. Afterwards, the autopointer is returned to its pool.
-
- 1.8.17
-
-
-
diff --git a/docs/html/automatic-pool_8h__incl.map b/docs/html/automatic-pool_8h__incl.map
deleted file mode 100644
index f08d690..0000000
--- a/docs/html/automatic-pool_8h__incl.map
+++ /dev/null
@@ -1,6 +0,0 @@
-
diff --git a/docs/html/automatic-pool_8h__incl.md5 b/docs/html/automatic-pool_8h__incl.md5
deleted file mode 100644
index d99e40a..0000000
--- a/docs/html/automatic-pool_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-5680677957ec5d9de6f4454e1f430082
\ No newline at end of file
diff --git a/docs/html/automatic-pool_8h__incl.png b/docs/html/automatic-pool_8h__incl.png
deleted file mode 100644
index dd3999a..0000000
Binary files a/docs/html/automatic-pool_8h__incl.png and /dev/null differ
diff --git a/docs/html/automatic-pool_8h_source.html b/docs/html/automatic-pool_8h_source.html
deleted file mode 100644
index 0d82fd4..0000000
--- a/docs/html/automatic-pool_8h_source.html
+++ /dev/null
@@ -1,157 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/bc_s.png b/docs/html/bc_s.png
deleted file mode 100644
index 224b29a..0000000
Binary files a/docs/html/bc_s.png and /dev/null differ
diff --git a/docs/html/bdwn.png b/docs/html/bdwn.png
deleted file mode 100644
index 940a0b9..0000000
Binary files a/docs/html/bdwn.png and /dev/null differ
diff --git a/docs/html/circular-queue_8h.html b/docs/html/circular-queue_8h.html
deleted file mode 100644
index 527b479..0000000
--- a/docs/html/circular-queue_8h.html
+++ /dev/null
@@ -1,427 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines circular queues, fast and efficient FIFO data structures. -More...
-
Go to the source code of this file.
--Data Structures | |
| struct | uel_cqueue_t |
| Defines a circular queue of void pointers. More... | |
-Functions | |
| void | uel_cqueue_init (uel_cqueue_t *queue, void **buffer, uintptr_t size_log2n) |
| Initialised a circular queue object. More... | |
| void | uel_cqueue_clear (uel_cqueue_t *queue, bool clear_buffer) |
| Empties a queue by resetting its tail and count values. More... | |
| bool | uel_cqueue_push (uel_cqueue_t *queue, void *element) |
| Pushes an element into the queue. More... | |
| void * | uel_cqueue_pop (uel_cqueue_t *queue) |
| Pops an element from the queue. More... | |
| void * | uel_cqueue_peek_tail (uel_cqueue_t *queue) |
| Peeks the tail of the queue, where the oldest element is enqueued. This is the element that will be returned on the next pop operation. More... | |
| void * | uel_cqueue_peek_head (uel_cqueue_t *queue) |
| Peeks the head of the queue, where the newest element is enqueued. This is the element that was enqueued on the last push operation. More... | |
| bool | uel_cqueue_is_full (uel_cqueue_t *queue) |
| Checks if the queue is full. More... | |
| bool | uel_cqueue_is_empty (uel_cqueue_t *queue) |
| Checks if the queue is empty. Use this before popping from the queue. More... | |
| uintptr_t | uel_cqueue_count (uel_cqueue_t *queue) |
| Counts the number o elements in the queue. More... | |
Defines circular queues, fast and efficient FIFO data structures.
-| void uel_cqueue_clear | -( | -uel_cqueue_t * | -queue, | -
| - | - | bool | -clear_buffer | -
| - | ) | -- |
Empties a queue by resetting its tail and count values.
-| queue | The queue to be cleared. |
| clear_buffer | If this is set, completely de-initialises the queue. |
| uintptr_t uel_cqueue_count | -( | -uel_cqueue_t * | -queue | ) | -- |
Counts the number o elements in the queue.
-| queue | The queue whoese elements should be counted |
| void uel_cqueue_init | -( | -uel_cqueue_t * | -queue, | -
| - | - | void ** | -buffer, | -
| - | - | uintptr_t | -size_log2n | -
| - | ) | -- |
Initialised a circular queue object.
-| queue | The queue object to be intialised |
| buffer | An array of void pointers that will be used to store the enqueued values. |
| size_log2n | The size of the queue in its log2 form. |
| bool uel_cqueue_is_empty | -( | -uel_cqueue_t * | -queue | ) | -- |
Checks if the queue is empty. Use this before popping from the queue.
-| queue | The queue to check |
| bool uel_cqueue_is_full | -( | -uel_cqueue_t * | -queue | ) | -- |
Checks if the queue is full.
-| queue | The queue to check |
| void* uel_cqueue_peek_head | -( | -uel_cqueue_t * | -queue | ) | -- |
Peeks the head of the queue, where the newest element is enqueued. This is the element that was enqueued on the last push operation.
-| queue | The queue to peek |
| void* uel_cqueue_peek_tail | -( | -uel_cqueue_t * | -queue | ) | -- |
Peeks the tail of the queue, where the oldest element is enqueued. This is the element that will be returned on the next pop operation.
-| queue | The queue to peek |
| void* uel_cqueue_pop | -( | -uel_cqueue_t * | -queue | ) | -- |
Pops an element from the queue.
-| queue | The queue from where to pop |
| bool uel_cqueue_push | -( | -uel_cqueue_t * | -queue, | -
| - | - | void * | -element | -
| - | ) | -- |
Pushes an element into the queue.
-| queue | The queue into which to push the element |
| element | The element to be pushed into the queue |
- 1.8.17
-
-
-
diff --git a/docs/html/circular-queue_8h__dep__incl.map b/docs/html/circular-queue_8h__dep__incl.map
deleted file mode 100644
index 1f3ac68..0000000
--- a/docs/html/circular-queue_8h__dep__incl.map
+++ /dev/null
@@ -1,12 +0,0 @@
-
diff --git a/docs/html/circular-queue_8h__dep__incl.md5 b/docs/html/circular-queue_8h__dep__incl.md5
deleted file mode 100644
index d334ed8..0000000
--- a/docs/html/circular-queue_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-fb05972a720bacdc7cdf980c3c247cb5
\ No newline at end of file
diff --git a/docs/html/circular-queue_8h__dep__incl.png b/docs/html/circular-queue_8h__dep__incl.png
deleted file mode 100644
index 8945a16..0000000
Binary files a/docs/html/circular-queue_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/circular-queue_8h_source.html b/docs/html/circular-queue_8h_source.html
deleted file mode 100644
index cd043aa..0000000
--- a/docs/html/circular-queue_8h_source.html
+++ /dev/null
@@ -1,131 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/classes.html b/docs/html/classes.html
deleted file mode 100644
index 069a01b..0000000
--- a/docs/html/classes.html
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/closed.png b/docs/html/closed.png
deleted file mode 100644
index 98cc2c9..0000000
Binary files a/docs/html/closed.png and /dev/null differ
diff --git a/docs/html/closure_8h.html b/docs/html/closure_8h.html
deleted file mode 100644
index 3a5d7a1..0000000
--- a/docs/html/closure_8h.html
+++ /dev/null
@@ -1,254 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines closures, objects that bind functions to creating and calling contexts. -More...
-
Go to the source code of this file.
--Data Structures | |
| struct | uel_closure_t |
| Defines a closure, a tuple <function, context, destructor> More... | |
-Typedefs | |
| typedef void *(* | uel_closure_function_t) (void *context, void *params) |
| Defines a closure function, suitable for being bound at a closure. More... | |
-Functions | |
| uel_closure_t | uel_closure_create (uel_closure_function_t function, void *context) |
| Creates a new closure. More... | |
| void * | uel_closure_invoke (uel_closure_t *closure, void *params) |
| Invokes a closure and returns whatever value it returned. More... | |
| uel_closure_t | uel_nop () |
| Returns a closure that does nothing. More... | |
Defines closures, objects that bind functions to creating and calling contexts.
-| typedef void*(* uel_closure_function_t) (void *context, void *params) | -
Defines a closure function, suitable for being bound at a closure.
-Must take two pointers ar arguments, one for the context and one for closure parameters. Must return a void pointer.
- -| uel_closure_t uel_closure_create | -( | -uel_closure_function_t | -function, | -
| - | - | void * | -context | -
| - | ) | -- |
Creates a new closure.
-Binds the tuple <function, context> and populates a new closure object with it. The object is returned by value.
| function | The function to be run on closure invokation. |
| context | The creation context of the closure. |
| void* uel_closure_invoke | -( | -uel_closure_t * | -closure, | -
| - | - | void * | -params | -
| - | ) | -- |
Invokes a closure and returns whatever value it returned.
-| closure | The closure reference to be invoked. |
| params | The parameters to be passed along during closure invokation. |
| uel_closure_t uel_nop | -( | -) | -- |
Returns a closure that does nothing.
-The returned closure can be passed as parameters to functions that take closures as callbacks when the caller does not need to callback.
- -
- 1.8.17
-
-
-
diff --git a/docs/html/closure_8h__dep__incl.map b/docs/html/closure_8h__dep__incl.map
deleted file mode 100644
index b787ac7..0000000
--- a/docs/html/closure_8h__dep__incl.map
+++ /dev/null
@@ -1,17 +0,0 @@
-
diff --git a/docs/html/closure_8h__dep__incl.md5 b/docs/html/closure_8h__dep__incl.md5
deleted file mode 100644
index 067447e..0000000
--- a/docs/html/closure_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-f30209a286066a15ec82429a4d63e3a0
\ No newline at end of file
diff --git a/docs/html/closure_8h__dep__incl.png b/docs/html/closure_8h__dep__incl.png
deleted file mode 100644
index 5e9ff1a..0000000
Binary files a/docs/html/closure_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/closure_8h_source.html b/docs/html/closure_8h_source.html
deleted file mode 100644
index 409e8ea..0000000
--- a/docs/html/closure_8h_source.html
+++ /dev/null
@@ -1,106 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/conditional_8h.html b/docs/html/conditional_8h.html
deleted file mode 100644
index d89ee25..0000000
--- a/docs/html/conditional_8h.html
+++ /dev/null
@@ -1,217 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains definitions of functional conditionals, structures that act as if-else constructs. -More...
-#include "uevloop/utils/closure.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_conditional_t |
| Conditionals are constructs that provide functional flow control. More... | |
-Functions | |
| void | uel_conditional_init (uel_conditional_t *conditional, uel_closure_t test, uel_closure_t if_true, uel_closure_t if_false) |
| Initialises a conditional structure. More... | |
| void * | uel_conditional_apply (uel_conditional_t *conditional, void *params) |
| Applies a conditional do some input. More... | |
Contains definitions of functional conditionals, structures that act as if-else constructs.
-| void* uel_conditional_apply | -( | -uel_conditional_t * | -conditional, | -
| - | - | void * | -params | -
| - | ) | -- |
Applies a conditional do some input.
-This function takes some input and submits it to the test closure, whose output will be cast to a boolean value. According to this value, either if_true or if_false closures will be called with the same value as parameters.
| conditional | The conditional to be applied |
| params | The parameter that will be tested and provided to the chosen closure |
| void uel_conditional_init | -( | -uel_conditional_t * | -conditional, | -
| - | - | uel_closure_t | -test, | -
| - | - | uel_closure_t | -if_true, | -
| - | - | uel_closure_t | -if_false | -
| - | ) | -- |
Initialises a conditional structure.
-| conditional | The conditional object to be initialised |
| test | The closure to test the input in order to decide what to do next |
| if_true | The closure to be invoked when the test closure returns true |
| if_false | The closure to be invoked when the test closure returns false |
- 1.8.17
-
-
-
diff --git a/docs/html/conditional_8h__dep__incl.map b/docs/html/conditional_8h__dep__incl.map
deleted file mode 100644
index 0060105..0000000
--- a/docs/html/conditional_8h__dep__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/conditional_8h__dep__incl.md5 b/docs/html/conditional_8h__dep__incl.md5
deleted file mode 100644
index 7dd41b8..0000000
--- a/docs/html/conditional_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-39c6bc037b27d37e18ba54b14b839779
\ No newline at end of file
diff --git a/docs/html/conditional_8h__dep__incl.png b/docs/html/conditional_8h__dep__incl.png
deleted file mode 100644
index 5f0cac3..0000000
Binary files a/docs/html/conditional_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/conditional_8h__incl.map b/docs/html/conditional_8h__incl.map
deleted file mode 100644
index 2860df9..0000000
--- a/docs/html/conditional_8h__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/conditional_8h__incl.md5 b/docs/html/conditional_8h__incl.md5
deleted file mode 100644
index aa8a8ef..0000000
--- a/docs/html/conditional_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-ecf3129280a21e3923f9404b96b9d5e5
\ No newline at end of file
diff --git a/docs/html/conditional_8h__incl.png b/docs/html/conditional_8h__incl.png
deleted file mode 100644
index 99a6c3e..0000000
Binary files a/docs/html/conditional_8h__incl.png and /dev/null differ
diff --git a/docs/html/conditional_8h_source.html b/docs/html/conditional_8h_source.html
deleted file mode 100644
index 6ac6609..0000000
--- a/docs/html/conditional_8h_source.html
+++ /dev/null
@@ -1,107 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/config_8h.html b/docs/html/config_8h.html
deleted file mode 100644
index 9dddb8b..0000000
--- a/docs/html/config_8h.html
+++ /dev/null
@@ -1,133 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Central repository of system configuration. This is meant to be edited by the programmer as needed. -More...
-
Go to the source code of this file.
--Macros | |
| -#define | UEL_SYSPOOLS_EVENT_POOL_SIZE_LOG2N (7) |
| Defines the size of the event pool size in log2 form. Defaults to 128 events. | |
| -#define | UEL_SYSPOOLS_LLIST_NODE_POOL_SIZE_LOG2N (7) |
| Defines the size of the linked list node pool size in log2 form. Defaults to 128 nodes. | |
| -#define | UEL_SYSQUEUES_EVENT_QUEUE_SIZE_LOG2N (5) |
| The size of the event queue in log2 form. Defaults to 32 events. | |
| -#define | UEL_SYSQUEUES_SCHEDULE_QUEUE_SIZE_LOG2N (4) |
| The size of the schedule queue in log2 form. Defaults to 32 events. | |
| -#define | UEL_SIGNAL_MAX_LISTENERS (5) |
| Defines the max number of listeners to be attached to an speciffic signal in a single relay. | |
| -#define | UEL_PROMISE_SHORTCUTS |
| Enable promise chain functions aliases: THEN, CATCH, AFTER, ALWAYS. | |
Central repository of system configuration. This is meant to be edited by the programmer as needed.
-
- 1.8.17
-
-
-
diff --git a/docs/html/config_8h__dep__incl.map b/docs/html/config_8h__dep__incl.map
deleted file mode 100644
index 265063e..0000000
--- a/docs/html/config_8h__dep__incl.map
+++ /dev/null
@@ -1,10 +0,0 @@
-
diff --git a/docs/html/config_8h__dep__incl.md5 b/docs/html/config_8h__dep__incl.md5
deleted file mode 100644
index 7e4ebcd..0000000
--- a/docs/html/config_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-71475bea109d5215ef9ed22c68c1fa05
\ No newline at end of file
diff --git a/docs/html/config_8h__dep__incl.png b/docs/html/config_8h__dep__incl.png
deleted file mode 100644
index a4f4807..0000000
Binary files a/docs/html/config_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/config_8h_source.html b/docs/html/config_8h_source.html
deleted file mode 100644
index be0e0f2..0000000
--- a/docs/html/config_8h_source.html
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/critical-section_8h.html b/docs/html/critical-section_8h.html
deleted file mode 100644
index badcf80..0000000
--- a/docs/html/critical-section_8h.html
+++ /dev/null
@@ -1,135 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains macros for delimitating critical sections. -More...
- -Go to the source code of this file.
--Macros | |
| #define | UEL_CRITICAL_ENTER |
| Enters a critical section. More... | |
| #define | UEL_CRITICAL_EXIT |
| Exits a critical section.. More... | |
Contains macros for delimitating critical sections.
-| #define UEL_CRITICAL_ENTER | -
Enters a critical section.
-This is a no-op meant to be overridden by the programmer, according to the synchronisation methods available on the target platform.
- -| #define UEL_CRITICAL_EXIT | -
Exits a critical section..
-This is a no-op meant to be overridden by the programmer, according to the synchronisation methods available on the target platform.
- -
- 1.8.17
-
-
-
diff --git a/docs/html/critical-section_8h_source.html b/docs/html/critical-section_8h_source.html
deleted file mode 100644
index e11f765..0000000
--- a/docs/html/critical-section_8h_source.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/dir_000003_000004.html b/docs/html/dir_000003_000004.html
deleted file mode 100644
index 60400d0..0000000
--- a/docs/html/dir_000003_000004.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
| File in include/uevloop/system | Includes file in include/uevloop/system/containers |
|---|---|
| event-loop.h | system-pools.h |
| event-loop.h | system-queues.h |
| scheduler.h | system-pools.h |
| scheduler.h | system-queues.h |
| signal.h | system-pools.h |
| signal.h | system-queues.h |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_000003_000005.html b/docs/html/dir_000003_000005.html
deleted file mode 100644
index ded41b7..0000000
--- a/docs/html/dir_000003_000005.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
| File in include/uevloop/system | Includes file in include/uevloop/utils |
|---|---|
| containers / application.h | module.h |
| event-loop.h | closure.h |
| event-loop.h | linked-list.h |
| event.h | closure.h |
| event.h | linked-list.h |
| scheduler.h | closure.h |
| scheduler.h | linked-list.h |
| signal.h | closure.h |
| signal.h | linked-list.h |
| signal.h | promise.h |
| containers / system-pools.h | linked-list.h |
| containers / system-pools.h | object-pool.h |
| containers / system-queues.h | circular-queue.h |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_000004_000005.html b/docs/html/dir_000004_000005.html
deleted file mode 100644
index 492155a..0000000
--- a/docs/html/dir_000004_000005.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
| File in include/uevloop/system/containers | Includes file in include/uevloop/utils |
|---|---|
| application.h | module.h |
| system-pools.h | linked-list.h |
| system-pools.h | object-pool.h |
| system-queues.h | circular-queue.h |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8.html b/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8.html
deleted file mode 100644
index 6a6c0ed..0000000
--- a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8.html
+++ /dev/null
@@ -1,105 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
-Files | |
| file | application.h [code] |
| The application module is a convenient top-level container for the system internals. | |
| file | system-pools.h [code] |
| A container for the system's internal pools. | |
| file | system-queues.h [code] |
| A container for the system's internal queues. | |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.map b/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.map
deleted file mode 100644
index 2b8ddee..0000000
--- a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.map
+++ /dev/null
@@ -1,6 +0,0 @@
-
diff --git a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.md5 b/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.md5
deleted file mode 100644
index 35732cf..0000000
--- a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.md5
+++ /dev/null
@@ -1 +0,0 @@
-c22fe9edb2f1025991594a2e9f403659
\ No newline at end of file
diff --git a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.png b/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.png
deleted file mode 100644
index d02c2a5..0000000
Binary files a/docs/html/dir_07ca576fdadbb370dc7f55dcdd06f8b8_dep.png and /dev/null differ
diff --git a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175.html b/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175.html
deleted file mode 100644
index 5c4d8a0..0000000
--- a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175.html
+++ /dev/null
@@ -1,126 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
-Files | |
| file | automatic-pool.h [code] |
| Defines automatic pointers and automatic pools, objects that wrap object pools and objects managed by them. These wrappers provide basic automatic memory management. | |
| file | circular-queue.h [code] |
| Defines circular queues, fast and efficient FIFO data structures. | |
| file | closure.h [code] |
| Defines closures, objects that bind functions to creating and calling contexts. | |
| file | conditional.h [code] |
| Contains definitions of functional conditionals, structures that act as if-else constructs. | |
| file | functional.h [code] |
| Contains helpers for composing and augumenting closures. | |
| file | iterator.h [code] |
| Defines iterators, structures and functions suitable for enumerating other data structures. | |
| file | linked-list.h [code] |
| Defines a simple implementation of linked lists and functions to manipulate it. | |
| file | module.h [code] |
| file | object-pool.h [code] |
| Defines object pools, arrays of pre-allocated objects for dynamic use. | |
| file | pipeline.h [code] |
| Defines pipelines, structures to hold many closures and functions to invoke them sequentially, composing their functionality. | |
| file | promise.h [code] |
| Contains definitions for promise stores, promises and functions to manipulate them. | |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.map b/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.map
deleted file mode 100644
index e364212..0000000
--- a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.md5 b/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.md5
deleted file mode 100644
index f9334e4..0000000
--- a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.md5
+++ /dev/null
@@ -1 +0,0 @@
-47e250b26559c37b726b1bdc4d5ece39
\ No newline at end of file
diff --git a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.png b/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.png
deleted file mode 100644
index f725e77..0000000
Binary files a/docs/html/dir_0b107f87463abbc8b2ae6ed1ed981175_dep.png and /dev/null differ
diff --git a/docs/html/dir_1c07dc2bb514f68216b7275ce8a19048.html b/docs/html/dir_1c07dc2bb514f68216b7275ce8a19048.html
deleted file mode 100644
index ac6e3d0..0000000
--- a/docs/html/dir_1c07dc2bb514f68216b7275ce8a19048.html
+++ /dev/null
@@ -1,88 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
-Files | |
| file | critical-section.h [code] |
| Contains macros for delimitating critical sections. | |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e.html b/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e.html
deleted file mode 100644
index 311bad8..0000000
--- a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e.html
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
-Directories |
-Files | |
| file | event-loop.h [code] |
| Module responsible for running enqueued events and process them accordingly. | |
| file | event.h [code] |
| Defines events and methods to configure events. | |
| file | scheduler.h [code] |
| Module responsible for keeping track of time and tasks to be run in the future. | |
| file | signal.h [code] |
| Defines signals and relays, structures used to communicate asynchronously between distant parts of the application. | |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.map b/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.map
deleted file mode 100644
index b3fba2a..0000000
--- a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.map
+++ /dev/null
@@ -1,8 +0,0 @@
-
diff --git a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.md5 b/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.md5
deleted file mode 100644
index 796c15a..0000000
--- a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.md5
+++ /dev/null
@@ -1 +0,0 @@
-27d2246bf8988d04a04bf2ac5dd068cc
\ No newline at end of file
diff --git a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.png b/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.png
deleted file mode 100644
index 4195252..0000000
Binary files a/docs/html/dir_abb95c841d2d19e4a38c0aebc4f3511e_dep.png and /dev/null differ
diff --git a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d.html b/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d.html
deleted file mode 100644
index 4578d81..0000000
--- a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d.html
+++ /dev/null
@@ -1,104 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
-Directories |
-Files | |
| file | config.h [code] |
| Central repository of system configuration. This is meant to be edited by the programmer as needed. | |
- 1.8.17
-
-
-
diff --git a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.map b/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.map
deleted file mode 100644
index 8a33df2..0000000
--- a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.map
+++ /dev/null
@@ -1,8 +0,0 @@
-
diff --git a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.md5 b/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.md5
deleted file mode 100644
index 5f7f4b4..0000000
--- a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.md5
+++ /dev/null
@@ -1 +0,0 @@
-c400a420274262f99f6c16af2141fca4
\ No newline at end of file
diff --git a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.png b/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.png
deleted file mode 100644
index c35a6b4..0000000
Binary files a/docs/html/dir_bf342d982ec00e45652f5a4c01fdc40d_dep.png and /dev/null differ
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
deleted file mode 100644
index 92b58a9..0000000
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ /dev/null
@@ -1,94 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.map b/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.map
deleted file mode 100644
index 9f1f5f3..0000000
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.md5 b/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.md5
deleted file mode 100644
index 9b19834..0000000
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.md5
+++ /dev/null
@@ -1 +0,0 @@
-e3a17f216c33f837c64ca30f197dfe24
\ No newline at end of file
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.png b/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.png
deleted file mode 100644
index 8871dd3..0000000
Binary files a/docs/html/dir_d44c64559bbebec7f509842c48db8b23_dep.png and /dev/null differ
diff --git a/docs/html/doc.png b/docs/html/doc.png
deleted file mode 100644
index 17edabf..0000000
Binary files a/docs/html/doc.png and /dev/null differ
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
deleted file mode 100644
index 73ecbb2..0000000
--- a/docs/html/doxygen.css
+++ /dev/null
@@ -1,1771 +0,0 @@
-/* The standard CSS for doxygen 1.8.17 */
-
-body, table, div, p, dl {
- font: 400 14px/22px Roboto,sans-serif;
-}
-
-p.reference, p.definition {
- font: 400 14px/22px Roboto,sans-serif;
-}
-
-/* @group Heading Levels */
-
-h1.groupheader {
- font-size: 150%;
-}
-
-.title {
- font: 400 14px/28px Roboto,sans-serif;
- font-size: 150%;
- font-weight: bold;
- margin: 10px 2px;
-}
-
-h2.groupheader {
- border-bottom: 1px solid #879ECB;
- color: #354C7B;
- font-size: 150%;
- font-weight: normal;
- margin-top: 1.75em;
- padding-top: 8px;
- padding-bottom: 4px;
- width: 100%;
-}
-
-h3.groupheader {
- font-size: 100%;
-}
-
-h1, h2, h3, h4, h5, h6 {
- -webkit-transition: text-shadow 0.5s linear;
- -moz-transition: text-shadow 0.5s linear;
- -ms-transition: text-shadow 0.5s linear;
- -o-transition: text-shadow 0.5s linear;
- transition: text-shadow 0.5s linear;
- margin-right: 15px;
-}
-
-h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
- text-shadow: 0 0 15px cyan;
-}
-
-dt {
- font-weight: bold;
-}
-
-ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
-}
-
-p.startli, p.startdd {
- margin-top: 2px;
-}
-
-th p.starttd, p.intertd, p.endtd {
- font-size: 100%;
- font-weight: 700;
-}
-
-p.starttd {
- margin-top: 0px;
-}
-
-p.endli {
- margin-bottom: 0px;
-}
-
-p.enddd {
- margin-bottom: 4px;
-}
-
-p.endtd {
- margin-bottom: 2px;
-}
-
-p.interli {
-}
-
-p.interdd {
-}
-
-p.intertd {
-}
-
-/* @end */
-
-caption {
- font-weight: bold;
-}
-
-span.legend {
- font-size: 70%;
- text-align: center;
-}
-
-h3.version {
- font-size: 90%;
- text-align: center;
-}
-
-div.qindex, div.navtab{
- background-color: #EBEFF6;
- border: 1px solid #A3B4D7;
- text-align: center;
-}
-
-div.qindex, div.navpath {
- width: 100%;
- line-height: 140%;
-}
-
-div.navtab {
- margin-right: 15px;
-}
-
-/* @group Link Styling */
-
-a {
- color: #3D578C;
- font-weight: normal;
- text-decoration: none;
-}
-
-.contents a:visited {
- color: #4665A2;
-}
-
-a:hover {
- text-decoration: underline;
-}
-
-a.qindex {
- font-weight: bold;
-}
-
-a.qindexHL {
- font-weight: bold;
- background-color: #9CAFD4;
- color: #FFFFFF;
- border: 1px double #869DCA;
-}
-
-.contents a.qindexHL:visited {
- color: #FFFFFF;
-}
-
-a.el {
- font-weight: bold;
-}
-
-a.elRef {
-}
-
-a.code, a.code:visited, a.line, a.line:visited {
- color: #4665A2;
-}
-
-a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: #4665A2;
-}
-
-/* @end */
-
-dl.el {
- margin-left: -1cm;
-}
-
-ul {
- overflow: hidden; /*Fixed: list item bullets overlap floating elements*/
-}
-
-#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
-}
-
-#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
-}
-
-.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/
- overflow-y: hidden;
-}
-
-pre.fragment {
- border: 1px solid #C4CFE5;
- background-color: #FBFCFD;
- padding: 4px 6px;
- margin: 4px 8px 4px 2px;
- overflow: auto;
- word-wrap: break-word;
- font-size: 9pt;
- line-height: 125%;
- font-family: monospace, fixed;
- font-size: 105%;
-}
-
-div.fragment {
- padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/
- margin: 4px 8px 4px 2px;
- background-color: #FBFCFD;
- border: 1px solid #C4CFE5;
-}
-
-div.line {
- font-family: monospace, fixed;
- font-size: 13px;
- min-height: 13px;
- line-height: 1.0;
- text-wrap: unrestricted;
- white-space: -moz-pre-wrap; /* Moz */
- white-space: -pre-wrap; /* Opera 4-6 */
- white-space: -o-pre-wrap; /* Opera 7 */
- white-space: pre-wrap; /* CSS3 */
- word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
- padding-bottom: 0px;
- margin: 0px;
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
- transition-property: background-color, box-shadow;
- transition-duration: 0.5s;
-}
-
-div.line:after {
- content:"\000A";
- white-space: pre;
-}
-
-div.line.glow {
- background-color: cyan;
- box-shadow: 0 0 10px cyan;
-}
-
-
-span.lineno {
- padding-right: 4px;
- text-align: right;
- border-right: 2px solid #0F0;
- background-color: #E8E8E8;
- white-space: pre;
-}
-span.lineno a {
- background-color: #D8D8D8;
-}
-
-span.lineno a:hover {
- background-color: #C8C8C8;
-}
-
-.lineno {
- -webkit-touch-callout: none;
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
-}
-
-div.ah, span.ah {
- background-color: black;
- font-weight: bold;
- color: #FFFFFF;
- margin-bottom: 3px;
- margin-top: 3px;
- padding: 0.2em;
- border: solid thin #333;
- border-radius: 0.5em;
- -webkit-border-radius: .5em;
- -moz-border-radius: .5em;
- box-shadow: 2px 2px 3px #999;
- -webkit-box-shadow: 2px 2px 3px #999;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
- background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
- background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%);
-}
-
-div.classindex ul {
- list-style: none;
- padding-left: 0;
-}
-
-div.classindex span.ai {
- display: inline-block;
-}
-
-div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
-}
-
-div.groupText {
- margin-left: 16px;
- font-style: italic;
-}
-
-body {
- background-color: white;
- color: black;
- margin: 0;
-}
-
-div.contents {
- margin-top: 10px;
- margin-left: 12px;
- margin-right: 8px;
-}
-
-td.indexkey {
- background-color: #EBEFF6;
- font-weight: bold;
- border: 1px solid #C4CFE5;
- margin: 2px 0px 2px 0;
- padding: 2px 10px;
- white-space: nowrap;
- vertical-align: top;
-}
-
-td.indexvalue {
- background-color: #EBEFF6;
- border: 1px solid #C4CFE5;
- padding: 2px 10px;
- margin: 2px 0px;
-}
-
-tr.memlist {
- background-color: #EEF1F7;
-}
-
-p.formulaDsp {
- text-align: center;
-}
-
-img.formulaDsp {
-
-}
-
-img.formulaInl, img.inline {
- vertical-align: middle;
-}
-
-div.center {
- text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
-}
-
-div.center img {
- border: 0px;
-}
-
-address.footer {
- text-align: right;
- padding-right: 12px;
-}
-
-img.footer {
- border: 0px;
- vertical-align: middle;
-}
-
-/* @group Code Colorization */
-
-span.keyword {
- color: #008000
-}
-
-span.keywordtype {
- color: #604020
-}
-
-span.keywordflow {
- color: #e08000
-}
-
-span.comment {
- color: #800000
-}
-
-span.preprocessor {
- color: #806020
-}
-
-span.stringliteral {
- color: #002080
-}
-
-span.charliteral {
- color: #008080
-}
-
-span.vhdldigit {
- color: #ff00ff
-}
-
-span.vhdlchar {
- color: #000000
-}
-
-span.vhdlkeyword {
- color: #700070
-}
-
-span.vhdllogic {
- color: #ff0000
-}
-
-blockquote {
- background-color: #F7F8FB;
- border-left: 2px solid #9CAFD4;
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
-}
-
-blockquote.DocNodeRTL {
- border-left: 0;
- border-right: 2px solid #9CAFD4;
- margin: 0 4px 0 24px;
- padding: 0 16px 0 12px;
-}
-
-/* @end */
-
-/*
-.search {
- color: #003399;
- font-weight: bold;
-}
-
-form.search {
- margin-bottom: 0px;
- margin-top: 0px;
-}
-
-input.search {
- font-size: 75%;
- color: #000080;
- font-weight: normal;
- background-color: #e8eef2;
-}
-*/
-
-td.tiny {
- font-size: 75%;
-}
-
-.dirtab {
- padding: 4px;
- border-collapse: collapse;
- border: 1px solid #A3B4D7;
-}
-
-th.dirtab {
- background: #EBEFF6;
- font-weight: bold;
-}
-
-hr {
- height: 0px;
- border: none;
- border-top: 1px solid #4A6AAA;
-}
-
-hr.footer {
- height: 1px;
-}
-
-/* @group Member Descriptions */
-
-table.memberdecls {
- border-spacing: 0px;
- padding: 0px;
-}
-
-.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
- transition-property: background-color, box-shadow;
- transition-duration: 0.5s;
-}
-
-.memberdecls td.glow, .fieldtable tr.glow {
- background-color: cyan;
- box-shadow: 0 0 15px cyan;
-}
-
-.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
- background-color: #F9FAFC;
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
-}
-
-.mdescLeft, .mdescRight {
- padding: 0px 8px 4px 8px;
- color: #555;
-}
-
-.memSeparator {
- border-bottom: 1px solid #DEE4F0;
- line-height: 1px;
- margin: 0px;
- padding: 0px;
-}
-
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
-}
-
-.memItemRight, .memTemplItemRight {
- width: 100%;
-}
-
-.memTemplParams {
- color: #4665A2;
- white-space: nowrap;
- font-size: 80%;
-}
-
-/* @end */
-
-/* @group Member Details */
-
-/* Styles for detailed member documentation */
-
-.memtitle {
- padding: 8px;
- border-top: 1px solid #A8B8D9;
- border-left: 1px solid #A8B8D9;
- border-right: 1px solid #A8B8D9;
- border-top-right-radius: 4px;
- border-top-left-radius: 4px;
- margin-bottom: -1px;
- background-image: url('nav_f.png');
- background-repeat: repeat-x;
- background-color: #E2E8F2;
- line-height: 1.25;
- font-weight: 300;
- float:left;
-}
-
-.permalink
-{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
-}
-
-.memtemplate {
- font-size: 80%;
- color: #4665A2;
- font-weight: normal;
- margin-left: 9px;
-}
-
-.memnav {
- background-color: #EBEFF6;
- border: 1px solid #A3B4D7;
- text-align: center;
- margin: 2px;
- margin-right: 15px;
- padding: 2px;
-}
-
-.mempage {
- width: 100%;
-}
-
-.memitem {
- padding: 0;
- margin-bottom: 10px;
- margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
-}
-
-.memitem.glow {
- box-shadow: 0 0 15px cyan;
-}
-
-.memname {
- font-weight: 400;
- margin-left: 6px;
-}
-
-.memname td {
- vertical-align: bottom;
-}
-
-.memproto, dl.reflist dt {
- border-top: 1px solid #A8B8D9;
- border-left: 1px solid #A8B8D9;
- border-right: 1px solid #A8B8D9;
- padding: 6px 0px 6px 0px;
- color: #253555;
- font-weight: bold;
- text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
- background-color: #DFE5F1;
- /* opera specific markup */
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
- /* firefox specific markup */
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- -moz-border-radius-topright: 4px;
- /* webkit specific markup */
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- -webkit-border-top-right-radius: 4px;
-
-}
-
-.overload {
- font-family: "courier new",courier,monospace;
- font-size: 65%;
-}
-
-.memdoc, dl.reflist dd {
- border-bottom: 1px solid #A8B8D9;
- border-left: 1px solid #A8B8D9;
- border-right: 1px solid #A8B8D9;
- padding: 6px 10px 2px 10px;
- background-color: #FBFCFD;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: #FFFFFF;
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-}
-
-dl.reflist dt {
- padding: 5px;
-}
-
-dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
-}
-
-.paramkey {
- text-align: right;
-}
-
-.paramtype {
- white-space: nowrap;
-}
-
-.paramname {
- color: #602020;
- white-space: nowrap;
-}
-.paramname em {
- font-style: normal;
-}
-.paramname code {
- line-height: 14px;
-}
-
-.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
-}
-
-.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
-}
-
-.params .paramdir, .tparams .paramdir {
- font-family: "courier new",courier,monospace;
- vertical-align: top;
-}
-
-table.mlabels {
- border-spacing: 0px;
-}
-
-td.mlabels-left {
- width: 100%;
- padding: 0px;
-}
-
-td.mlabels-right {
- vertical-align: bottom;
- padding: 0px;
- white-space: nowrap;
-}
-
-span.mlabels {
- margin-left: 8px;
-}
-
-span.mlabel {
- background-color: #728DC1;
- border-top:1px solid #5373B4;
- border-left:1px solid #5373B4;
- border-right:1px solid #C4CFE5;
- border-bottom:1px solid #C4CFE5;
- text-shadow: none;
- color: white;
- margin-right: 4px;
- padding: 2px 3px;
- border-radius: 3px;
- font-size: 7pt;
- white-space: nowrap;
- vertical-align: middle;
-}
-
-
-
-/* @end */
-
-/* these are for tree view inside a (index) page */
-
-div.directory {
- margin: 10px 0px;
- border-top: 1px solid #9CAFD4;
- border-bottom: 1px solid #9CAFD4;
- width: 100%;
-}
-
-.directory table {
- border-collapse:collapse;
-}
-
-.directory td {
- margin: 0px;
- padding: 0px;
- vertical-align: top;
-}
-
-.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
- padding-top: 3px;
-}
-
-.directory td.entry a {
- outline:none;
-}
-
-.directory td.entry a img {
- border: none;
-}
-
-.directory td.desc {
- width: 100%;
- padding-left: 6px;
- padding-right: 6px;
- padding-top: 3px;
- border-left: 1px solid rgba(0,0,0,0.05);
-}
-
-.directory tr.even {
- padding-left: 6px;
- background-color: #F7F8FB;
-}
-
-.directory img {
- vertical-align: -30%;
-}
-
-.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
-}
-
-.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
- color: #3D578C;
-}
-
-.arrow {
- color: #9CAFD4;
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
-}
-
-.icon {
- font-family: Arial, Helvetica;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: #728DC1;
- color: white;
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
-}
-
-.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
-}
-
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:url('folderopen.png');
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
-}
-
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:url('folderclosed.png');
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
-}
-
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:url('doc.png');
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
-}
-
-table.directory {
- font: 400 14px Roboto,sans-serif;
-}
-
-/* @end */
-
-div.dynheader {
- margin-top: 8px;
- -webkit-touch-callout: none;
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
-}
-
-address {
- font-style: normal;
- color: #2A3D61;
-}
-
-table.doxtable caption {
- caption-side: top;
-}
-
-table.doxtable {
- border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
-}
-
-table.doxtable td, table.doxtable th {
- border: 1px solid #2D4068;
- padding: 3px 7px 2px;
-}
-
-table.doxtable th {
- background-color: #374F7F;
- color: #FFFFFF;
- font-size: 110%;
- padding-bottom: 4px;
- padding-top: 5px;
-}
-
-table.fieldtable {
- /*width: 100%;*/
- margin-bottom: 10px;
- border: 1px solid #A8B8D9;
- border-spacing: 0px;
- -moz-border-radius: 4px;
- -webkit-border-radius: 4px;
- border-radius: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
- -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
-}
-
-.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
-}
-
-.fieldtable td.fieldtype, .fieldtable td.fieldname {
- white-space: nowrap;
- border-right: 1px solid #A8B8D9;
- border-bottom: 1px solid #A8B8D9;
- vertical-align: top;
-}
-
-.fieldtable td.fieldname {
- padding-top: 3px;
-}
-
-.fieldtable td.fielddoc {
- border-bottom: 1px solid #A8B8D9;
- /*width: 100%;*/
-}
-
-.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
-}
-
-.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
-}
-
-.fieldtable tr:last-child td {
- border-bottom: none;
-}
-
-.fieldtable th {
- background-image:url('nav_f.png');
- background-repeat:repeat-x;
- background-color: #E2E8F2;
- font-size: 90%;
- color: #253555;
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- -moz-border-radius-topleft: 4px;
- -moz-border-radius-topright: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid #A8B8D9;
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: url('tab_b.png');
- z-index: 101;
- overflow: hidden;
- font-size: 13px;
-}
-
-.navpath ul
-{
- font-size: 11px;
- background-image:url('tab_b.png');
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:#8AA0CC;
- border:solid 1px #C2CDE4;
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
- list-style-type:none;
- float:left;
- padding-left:10px;
- padding-right:15px;
- background-image:url('bc_s.png');
- background-repeat:no-repeat;
- background-position:right;
- color:#364D7C;
-}
-
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- text-decoration: none;
- outline: none;
- color: #283A5D;
- font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
- text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
- text-decoration: none;
-}
-
-.navpath li.navelem a:hover
-{
- color:#6884BD;
-}
-
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color:#364D7C;
- font-size: 8pt;
-}
-
-
-div.summary
-{
- float: right;
- font-size: 8pt;
- padding-right: 5px;
- width: 50%;
- text-align: right;
-}
-
-div.summary a
-{
- white-space: nowrap;
-}
-
-table.classindex
-{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
-}
-
-div.ingroups
-{
- font-size: 8pt;
- width: 50%;
- text-align: left;
-}
-
-div.ingroups a
-{
- white-space: nowrap;
-}
-
-div.header
-{
- background-image:url('nav_h.png');
- background-repeat:repeat-x;
- background-color: #F9FAFC;
- margin: 0px;
- border-bottom: 1px solid #C4CFE5;
-}
-
-div.headertitle
-{
- padding: 5px 5px 5px 10px;
-}
-
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
-dl {
- padding: 0 0 0 0;
-}
-
-/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.section.DocNodeRTL {
- margin-right: 0px;
- padding-right: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.note.DocNodeRTL {
- margin-left: 0;
- padding-left: 0;
- border-left: 0;
- margin-right: -7px;
- padding-right: 3px;
- border-right: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.warning.DocNodeRTL, dl.attention.DocNodeRTL {
- margin-left: 0;
- padding-left: 0;
- border-left: 0;
- margin-right: -7px;
- padding-right: 3px;
- border-right: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL {
- margin-left: 0;
- padding-left: 0;
- border-left: 0;
- margin-right: -7px;
- padding-right: 3px;
- border-right: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.deprecated.DocNodeRTL {
- margin-left: 0;
- padding-left: 0;
- border-left: 0;
- margin-right: -7px;
- padding-right: 3px;
- border-right: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.todo.DocNodeRTL {
- margin-left: 0;
- padding-left: 0;
- border-left: 0;
- margin-right: -7px;
- padding-right: 3px;
- border-right: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.test.DocNodeRTL {
- margin-left: 0;
- padding-left: 0;
- border-left: 0;
- margin-right: -7px;
- padding-right: 3px;
- border-right: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
-}
-
-dl.bug.DocNodeRTL {
- margin-left: 0;
- padding-left: 0;
- border-left: 0;
- margin-right: -7px;
- padding-right: 3px;
- border-right: 4px solid;
- border-color: #C08050;
-}
-
-dl.section dd {
- margin-bottom: 6px;
-}
-
-
-#projectlogo
-{
- text-align: center;
- vertical-align: bottom;
- border-collapse: separate;
-}
-
-#projectlogo img
-{
- border: 0px none;
-}
-
-#projectalign
-{
- vertical-align: middle;
-}
-
-#projectname
-{
- font: 300% Tahoma, Arial,sans-serif;
- margin: 0px;
- padding: 2px 0px;
-}
-
-#projectbrief
-{
- font: 120% Tahoma, Arial,sans-serif;
- margin: 0px;
- padding: 0px;
-}
-
-#projectnumber
-{
- font: 50% Tahoma, Arial,sans-serif;
- margin: 0px;
- padding: 0px;
-}
-
-#titlearea
-{
- padding: 0px;
- margin: 0px;
- width: 100%;
- border-bottom: 1px solid #5373B4;
-}
-
-.image
-{
- text-align: center;
-}
-
-.dotgraph
-{
- text-align: center;
-}
-
-.mscgraph
-{
- text-align: center;
-}
-
-.plantumlgraph
-{
- text-align: center;
-}
-
-.diagraph
-{
- text-align: center;
-}
-
-.caption
-{
- font-weight: bold;
-}
-
-div.zoom
-{
- border: 1px solid #90A5CE;
-}
-
-dl.citelist {
- margin-bottom:50px;
-}
-
-dl.citelist dt {
- color:#334975;
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
-}
-
-dl.citelist dd {
- margin:2px 0;
- padding:5px 0;
-}
-
-div.toc {
- padding: 14px 25px;
- background-color: #F4F6FA;
- border: 1px solid #D8DFEE;
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
-}
-
-.PageDocRTL-title div.toc {
- float: left !important;
- text-align: right;
-}
-
-div.toc li {
- background: url("bdwn.png") no-repeat scroll 0 5px transparent;
- font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
-}
-
-.PageDocRTL-title div.toc li {
- background-position-x: right !important;
- padding-left: 0 !important;
- padding-right: 10px;
-}
-
-div.toc h3 {
- font: bold 12px/1.2 Arial,FreeSans,sans-serif;
- color: #4665A2;
- border-bottom: 0 none;
- margin: 0;
-}
-
-div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
-}
-
-div.toc li.level1 {
- margin-left: 0px;
-}
-
-div.toc li.level2 {
- margin-left: 15px;
-}
-
-div.toc li.level3 {
- margin-left: 30px;
-}
-
-div.toc li.level4 {
- margin-left: 45px;
-}
-
-.PageDocRTL-title div.toc li.level1 {
- margin-left: 0 !important;
- margin-right: 0;
-}
-
-.PageDocRTL-title div.toc li.level2 {
- margin-left: 0 !important;
- margin-right: 15px;
-}
-
-.PageDocRTL-title div.toc li.level3 {
- margin-left: 0 !important;
- margin-right: 30px;
-}
-
-.PageDocRTL-title div.toc li.level4 {
- margin-left: 0 !important;
- margin-right: 45px;
-}
-
-.inherit_header {
- font-weight: bold;
- color: gray;
- cursor: pointer;
- -webkit-touch-callout: none;
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
-}
-
-.inherit_header td {
- padding: 6px 0px 2px 5px;
-}
-
-.inherit {
- display: none;
-}
-
-tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
-}
-
-/* tooltip related style info */
-
-.ttc {
- position: absolute;
- display: none;
-}
-
-#powerTip {
- cursor: default;
- white-space: nowrap;
- background-color: white;
- border: 1px solid gray;
- border-radius: 4px 4px 4px 4px;
- box-shadow: 1px 1px 7px gray;
- display: none;
- font-size: smaller;
- max-width: 80%;
- opacity: 0.9;
- padding: 1ex 1em 1em;
- position: absolute;
- z-index: 2147483647;
-}
-
-#powerTip div.ttdoc {
- color: grey;
- font-style: italic;
-}
-
-#powerTip div.ttname a {
- font-weight: bold;
-}
-
-#powerTip div.ttname {
- font-weight: bold;
-}
-
-#powerTip div.ttdeci {
- color: #006318;
-}
-
-#powerTip div {
- margin: 0px;
- padding: 0px;
- font: 12px/16px Roboto,sans-serif;
-}
-
-#powerTip:before, #powerTip:after {
- content: "";
- position: absolute;
- margin: 0px;
-}
-
-#powerTip.n:after, #powerTip.n:before,
-#powerTip.s:after, #powerTip.s:before,
-#powerTip.w:after, #powerTip.w:before,
-#powerTip.e:after, #powerTip.e:before,
-#powerTip.ne:after, #powerTip.ne:before,
-#powerTip.se:after, #powerTip.se:before,
-#powerTip.nw:after, #powerTip.nw:before,
-#powerTip.sw:after, #powerTip.sw:before {
- border: solid transparent;
- content: " ";
- height: 0;
- width: 0;
- position: absolute;
-}
-
-#powerTip.n:after, #powerTip.s:after,
-#powerTip.w:after, #powerTip.e:after,
-#powerTip.nw:after, #powerTip.ne:after,
-#powerTip.sw:after, #powerTip.se:after {
- border-color: rgba(255, 255, 255, 0);
-}
-
-#powerTip.n:before, #powerTip.s:before,
-#powerTip.w:before, #powerTip.e:before,
-#powerTip.nw:before, #powerTip.ne:before,
-#powerTip.sw:before, #powerTip.se:before {
- border-color: rgba(128, 128, 128, 0);
-}
-
-#powerTip.n:after, #powerTip.n:before,
-#powerTip.ne:after, #powerTip.ne:before,
-#powerTip.nw:after, #powerTip.nw:before {
- top: 100%;
-}
-
-#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: #FFFFFF;
- border-width: 10px;
- margin: 0px -10px;
-}
-#powerTip.n:before {
- border-top-color: #808080;
- border-width: 11px;
- margin: 0px -11px;
-}
-#powerTip.n:after, #powerTip.n:before {
- left: 50%;
-}
-
-#powerTip.nw:after, #powerTip.nw:before {
- right: 14px;
-}
-
-#powerTip.ne:after, #powerTip.ne:before {
- left: 14px;
-}
-
-#powerTip.s:after, #powerTip.s:before,
-#powerTip.se:after, #powerTip.se:before,
-#powerTip.sw:after, #powerTip.sw:before {
- bottom: 100%;
-}
-
-#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: #FFFFFF;
- border-width: 10px;
- margin: 0px -10px;
-}
-
-#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
- border-bottom-color: #808080;
- border-width: 11px;
- margin: 0px -11px;
-}
-
-#powerTip.s:after, #powerTip.s:before {
- left: 50%;
-}
-
-#powerTip.sw:after, #powerTip.sw:before {
- right: 14px;
-}
-
-#powerTip.se:after, #powerTip.se:before {
- left: 14px;
-}
-
-#powerTip.e:after, #powerTip.e:before {
- left: 100%;
-}
-#powerTip.e:after {
- border-left-color: #FFFFFF;
- border-width: 10px;
- top: 50%;
- margin-top: -10px;
-}
-#powerTip.e:before {
- border-left-color: #808080;
- border-width: 11px;
- top: 50%;
- margin-top: -11px;
-}
-
-#powerTip.w:after, #powerTip.w:before {
- right: 100%;
-}
-#powerTip.w:after {
- border-right-color: #FFFFFF;
- border-width: 10px;
- top: 50%;
- margin-top: -10px;
-}
-#powerTip.w:before {
- border-right-color: #808080;
- border-width: 11px;
- top: 50%;
- margin-top: -11px;
-}
-
-@media print
-{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
-}
-
-/* @group Markdown */
-
-/*
-table.markdownTable {
- border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
-}
-
-table.markdownTable td, table.markdownTable th {
- border: 1px solid #2D4068;
- padding: 3px 7px 2px;
-}
-
-table.markdownTableHead tr {
-}
-
-table.markdownTableBodyLeft td, table.markdownTable th {
- border: 1px solid #2D4068;
- padding: 3px 7px 2px;
-}
-
-th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone {
- background-color: #374F7F;
- color: #FFFFFF;
- font-size: 110%;
- padding-bottom: 4px;
- padding-top: 5px;
-}
-
-th.markdownTableHeadLeft {
- text-align: left
-}
-
-th.markdownTableHeadRight {
- text-align: right
-}
-
-th.markdownTableHeadCenter {
- text-align: center
-}
-*/
-
-table.markdownTable {
- border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
-}
-
-table.markdownTable td, table.markdownTable th {
- border: 1px solid #2D4068;
- padding: 3px 7px 2px;
-}
-
-table.markdownTable tr {
-}
-
-th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone {
- background-color: #374F7F;
- color: #FFFFFF;
- font-size: 110%;
- padding-bottom: 4px;
- padding-top: 5px;
-}
-
-th.markdownTableHeadLeft, td.markdownTableBodyLeft {
- text-align: left
-}
-
-th.markdownTableHeadRight, td.markdownTableBodyRight {
- text-align: right
-}
-
-th.markdownTableHeadCenter, td.markdownTableBodyCenter {
- text-align: center
-}
-
-.DocNodeRTL {
- text-align: right;
- direction: rtl;
-}
-
-.DocNodeLTR {
- text-align: left;
- direction: ltr;
-}
-
-table.DocNodeRTL {
- width: auto;
- margin-right: 0;
- margin-left: auto;
-}
-
-table.DocNodeLTR {
- width: auto;
- margin-right: auto;
- margin-left: 0;
-}
-
-tt, code, kbd, samp
-{
- display: inline-block;
- direction:ltr;
-}
-/* @end */
-
-u {
- text-decoration: underline;
-}
-
diff --git a/docs/html/doxygen.png b/docs/html/doxygen.png
deleted file mode 100644
index 3ff17d8..0000000
Binary files a/docs/html/doxygen.png and /dev/null differ
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
deleted file mode 100644
index ea0a7b3..0000000
--- a/docs/html/dynsections.js
+++ /dev/null
@@ -1,120 +0,0 @@
-/*
- @licstart The following is the entire license notice for the
- JavaScript code in this file.
-
- Copyright (C) 1997-2017 by Dimitri van Heesch
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
- @licend The above is the entire license notice
- for the JavaScript code in this file
- */
-function toggleVisibility(linkObj)
-{
- var base = $(linkObj).attr('id');
- var summary = $('#'+base+'-summary');
- var content = $('#'+base+'-content');
- var trigger = $('#'+base+'-trigger');
- var src=$(trigger).attr('src');
- if (content.is(':visible')===true) {
- content.hide();
- summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
- } else {
- content.show();
- summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
- }
- return false;
-}
-
-function updateStripes()
-{
- $('table.directory tr').
- removeClass('even').filter(':visible:even').addClass('even');
-}
-
-function toggleLevel(level)
-{
- $('table.directory tr').each(function() {
- var l = this.id.split('_').length-1;
- var i = $('#img'+this.id.substring(3));
- var a = $('#arr'+this.id.substring(3));
- if (l|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
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"
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... | |
Module responsible for running enqueued events and process them accordingly.
-| void uel_evloop_enqueue_closure | -( | -uel_evloop_t * | -event_loop, | -
| - | - | uel_closure_t * | -closure, | -
| - | - | void * | -value | -
| - | ) | -- |
Enqueues a closure to be invoked.
-| 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 |
| void uel_evloop_init | -( | -uel_evloop_t * | -event_loop, | -
| - | - | uel_syspools_t * | -pools, | -
| - | - | uel_sysqueues_t * | -queues | -
| - | ) | -- |
Initialises an event loop.
-| event_loop | The uel_evloop_t instance to be initialised |
| pools | The system's internal pools |
| queues | The system's internal queues |
| 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.
-| 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 |
| 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.
-| 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 |
| 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.
-| event_loop | The uel_evloop_t instance to be run |
- 1.8.17
-
-
-
diff --git a/docs/html/event-loop_8h__dep__incl.map b/docs/html/event-loop_8h__dep__incl.map
deleted file mode 100644
index b4823e3..0000000
--- a/docs/html/event-loop_8h__dep__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/event-loop_8h__dep__incl.md5 b/docs/html/event-loop_8h__dep__incl.md5
deleted file mode 100644
index 68a4cfd..0000000
--- a/docs/html/event-loop_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-2ae711a170678bdf59b6ec760b031efe
\ No newline at end of file
diff --git a/docs/html/event-loop_8h__dep__incl.png b/docs/html/event-loop_8h__dep__incl.png
deleted file mode 100644
index 31dbc6e..0000000
Binary files a/docs/html/event-loop_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/event-loop_8h__incl.map b/docs/html/event-loop_8h__incl.map
deleted file mode 100644
index 67dc7b8..0000000
--- a/docs/html/event-loop_8h__incl.map
+++ /dev/null
@@ -1,11 +0,0 @@
-
diff --git a/docs/html/event-loop_8h__incl.md5 b/docs/html/event-loop_8h__incl.md5
deleted file mode 100644
index e47c46c..0000000
--- a/docs/html/event-loop_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-8964d69c6e53dfcd87350402aeadcaae
\ No newline at end of file
diff --git a/docs/html/event-loop_8h__incl.png b/docs/html/event-loop_8h__incl.png
deleted file mode 100644
index 39b4206..0000000
Binary files a/docs/html/event-loop_8h__incl.png and /dev/null differ
diff --git a/docs/html/event-loop_8h_source.html b/docs/html/event-loop_8h_source.html
deleted file mode 100644
index ed5e42f..0000000
--- a/docs/html/event-loop_8h_source.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/event_8h.html b/docs/html/event_8h.html
deleted file mode 100644
index 7cdf67f..0000000
--- a/docs/html/event_8h.html
+++ /dev/null
@@ -1,575 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines events and methods to configure events. -More...
-
Go to the source code of this file.
--Data Structures | |
| struct | uel_event_t |
| Events are special messages passed around the core. They represent tasks to be run at some point by the system. More... | |
| union | uel_event_t::uel_event_detail |
| struct | uel_event_t::uel_event_detail::uel_event_timer |
| Contains information suitable for scheduling an event at the scheduler. More... | |
| struct | uel_event_t::uel_event_detail::uel_event_signal |
Contains information related to an emitted signal. More... | |
| struct | uel_event_t::uel_event_detail::uel_event_listener |
| Contains the context of a particular signal listener. More... | |
| struct | uel_event_t::uel_event_detail::uel_event_observer |
| Contains the reference to an observer variable. More... | |
-Typedefs | |
| -typedef enum uel_event_type | uel_event_type_t |
| Alias to the uel_event_type enum. | |
| -typedef enum uel_event_timer_status | uel_event_timer_status_t |
| Alias to the uel_event_timer_status. | |
-Enumerations | |
| enum | uel_event_type { - UEL_CLOSURE_EVENT, -UEL_TIMER_EVENT, -UEL_SIGNAL_EVENT, -UEL_SIGNAL_LISTENER_EVENT, - - UEL_OBSERVER_EVENT - - } |
| Possible types of events understood by the core. | |
| enum | uel_event_timer_status { UEL_TIMER_RUNNING, -UEL_TIMER_PAUSED, -UEL_TIMER_CANCELLED - } |
| Possible statuses for a timer event. | |
-Functions | |
| void | uel_event_config_closure (uel_event_t *event, uel_closure_t *closure, void *value, bool repeating) |
| Configures a closure event. More... | |
| void | uel_event_config_signal (uel_event_t *event, uintptr_t signal, uel_llist_t *listeners, void *params) |
| Configures a signal event. More... | |
| void | uel_event_config_signal_listener (uel_event_t *event, uel_closure_t *closure, bool repeating) |
| Configures a signal listener event. More... | |
| void | uel_event_config_observer (uel_event_t *event, uel_closure_t *closure, volatile uintptr_t *condition_var, bool repeating) |
| Configures an observer event. More... | |
| void | uel_event_observer_cancel (uel_event_t *event) |
| Cancels an observer. More... | |
| void | uel_event_config_timer (uel_event_t *event, uint16_t timeout_in_ms, bool repeating, bool immediate, uel_closure_t *closure, void *value, uint32_t current_time) |
| Configures a timer event. More... | |
| void | uel_event_timer_pause (uel_event_t *event) |
| Pauses a timer event. More... | |
| void | uel_event_timer_resume (uel_event_t *event) |
| Resumes a paused timer event. More... | |
| void | uel_event_timer_cancel (uel_event_t *event) |
| Cancels a timer event. More... | |
Defines events and methods to configure events.
-| void uel_event_config_closure | -( | -uel_event_t * | -event, | -
| - | - | uel_closure_t * | -closure, | -
| - | - | void * | -value, | -
| - | - | bool | -repeating | -
| - | ) | -- |
Configures a closure event.
-| event | The event to be configured |
| closure | The closure to be invoked when the event is run |
| value | The value to supply to the closure as parameters when it is invoked |
| repeating | Intructs the system whether should this event be disposed of after processing |
| void uel_event_config_observer | -( | -uel_event_t * | -event, | -
| - | - | uel_closure_t * | -closure, | -
| - | - | volatile uintptr_t * | -condition_var, | -
| - | - | bool | -repeating | -
| - | ) | -- |
Configures an observer event.
-| event | The event to be configured |
| closure | The closure to be invoked when the observed value changes |
| condition_var | The address of a volatile variable to be observed |
| repeating | Intructs the system whether should this event be disposed of after processing |
| void uel_event_config_signal | -( | -uel_event_t * | -event, | -
| - | - | uintptr_t | -signal, | -
| - | - | uel_llist_t * | -listeners, | -
| - | - | void * | -params | -
| - | ) | -- |
Configures a signal event.
-| event | The event to be configured |
| signal | The integer value that identifies this signal |
| listeners | The listeners associated to this signal |
| params | The parameters associated with this signal emission |
| void uel_event_config_signal_listener | -( | -uel_event_t * | -event, | -
| - | - | uel_closure_t * | -closure, | -
| - | - | bool | -repeating | -
| - | ) | -- |
Configures a signal listener event.
-| event | The event to be configured |
| closure | The closure to be invoked when the event is run |
| repeating | Intructs the system whether should this event be disposed of after processing |
| void uel_event_config_timer | -( | -uel_event_t * | -event, | -
| - | - | uint16_t | -timeout_in_ms, | -
| - | - | bool | -repeating, | -
| - | - | bool | -immediate, | -
| - | - | uel_closure_t * | -closure, | -
| - | - | void * | -value, | -
| - | - | uint32_t | -current_time | -
| - | ) | -- |
Configures a timer event.
-| event | The event to be configured |
| timeout_in_ms | The delay to process this event. If the event is repeating, this defines the interval between successive executions. |
| repeating | If this flag is set, the event will not be destroyed after execution. Instead it will be put on the schedule queue. |
| immediate | If this flag is set, a recurring timer will be immediately enqueued for processing. One-shot timers will ignore this setting. |
| closure | The closure to be invoked when the timer expires |
| value | The value to supply to the closure as parameters when it is invoked |
| current_time | The current value set in the system counter. |
| void uel_event_observer_cancel | -( | -uel_event_t * | -event | ) | -- |
Cancels an observer.
-| event | The observer event to be cancelled |
| void uel_event_timer_cancel | -( | -uel_event_t * | -event | ) | -- |
Cancels a timer event.
-| event | The timer event to be cancelled |
| void uel_event_timer_pause | -( | -uel_event_t * | -event | ) | -- |
Pauses a timer event.
-| event | The timer event to be paused |
| void uel_event_timer_resume | -( | -uel_event_t * | -event | ) | -- |
Resumes a paused timer event.
-| event | The timer event to be resumed |
- 1.8.17
-
-
-
diff --git a/docs/html/event_8h__dep__incl.map b/docs/html/event_8h__dep__incl.map
deleted file mode 100644
index 7284dc7..0000000
--- a/docs/html/event_8h__dep__incl.map
+++ /dev/null
@@ -1,9 +0,0 @@
-
diff --git a/docs/html/event_8h__dep__incl.md5 b/docs/html/event_8h__dep__incl.md5
deleted file mode 100644
index 6b5fedd..0000000
--- a/docs/html/event_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-b8641219d04107e5ab8fc723dcaeb00e
\ No newline at end of file
diff --git a/docs/html/event_8h__dep__incl.png b/docs/html/event_8h__dep__incl.png
deleted file mode 100644
index bb6f0d6..0000000
Binary files a/docs/html/event_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/event_8h__incl.map b/docs/html/event_8h__incl.map
deleted file mode 100644
index d55dfe9..0000000
--- a/docs/html/event_8h__incl.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/event_8h__incl.md5 b/docs/html/event_8h__incl.md5
deleted file mode 100644
index d0697b5..0000000
--- a/docs/html/event_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-d914d40d9b5258a79fdc20f8cea60760
\ No newline at end of file
diff --git a/docs/html/event_8h__incl.png b/docs/html/event_8h__incl.png
deleted file mode 100644
index f871573..0000000
Binary files a/docs/html/event_8h__incl.png and /dev/null differ
diff --git a/docs/html/event_8h_source.html b/docs/html/event_8h_source.html
deleted file mode 100644
index b3302c0..0000000
--- a/docs/html/event_8h_source.html
+++ /dev/null
@@ -1,222 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/files.html b/docs/html/files.html
deleted file mode 100644
index c991205..0000000
--- a/docs/html/files.html
+++ /dev/null
@@ -1,107 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
| ▼ include | |
| ▼ uevloop | |
| ▼ portability | |
| critical-section.h | Contains macros for delimitating critical sections |
| ▼ system | |
| ▼ containers | |
| application.h | The application module is a convenient top-level container for the system internals |
| system-pools.h | A container for the system's internal pools |
| system-queues.h | A container for the system's internal queues |
| event-loop.h | Module responsible for running enqueued events and process them accordingly |
| event.h | Defines events and methods to configure events |
| scheduler.h | Module responsible for keeping track of time and tasks to be run in the future |
| signal.h | Defines signals and relays, structures used to communicate asynchronously between distant parts of the application |
| ▼ utils | |
| automatic-pool.h | Defines automatic pointers and automatic pools, objects that wrap object pools and objects managed by them. These wrappers provide basic automatic memory management |
| circular-queue.h | Defines circular queues, fast and efficient FIFO data structures |
| closure.h | Defines closures, objects that bind functions to creating and calling contexts |
| conditional.h | Contains definitions of functional conditionals, structures that act as if-else constructs |
| functional.h | Contains helpers for composing and augumenting closures |
| iterator.h | Defines iterators, structures and functions suitable for enumerating other data structures |
| linked-list.h | Defines a simple implementation of linked lists and functions to manipulate it |
| module.h | |
| object-pool.h | Defines object pools, arrays of pre-allocated objects for dynamic use |
| pipeline.h | Defines pipelines, structures to hold many closures and functions to invoke them sequentially, composing their functionality |
| promise.h | Contains definitions for promise stores, promises and functions to manipulate them |
| config.h | Central repository of system configuration. This is meant to be edited by the programmer as needed |
- 1.8.17
-
-
-
diff --git a/docs/html/folderclosed.png b/docs/html/folderclosed.png
deleted file mode 100644
index bb8ab35..0000000
Binary files a/docs/html/folderclosed.png and /dev/null differ
diff --git a/docs/html/folderopen.png b/docs/html/folderopen.png
deleted file mode 100644
index d6c7f67..0000000
Binary files a/docs/html/folderopen.png and /dev/null differ
diff --git a/docs/html/functional_8h.html b/docs/html/functional_8h.html
deleted file mode 100644
index 0ac45f0..0000000
--- a/docs/html/functional_8h.html
+++ /dev/null
@@ -1,458 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains helpers for composing and augumenting closures. -More...
-#include "uevloop/utils/closure.h"#include "uevloop/utils/pipeline.h"#include "uevloop/utils/conditional.h"#include "uevloop/utils/iterator.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_func_mapper_t |
Maps elements of an iterator to an area of memory. Each element is assigned to a void pointer slot. More... | |
-Functions | |
| void | uel_func_mapper_init (uel_func_mapper_t *mapper, uel_iterator_t *iterator, void **destination, size_t limit) |
| Initialises a mapper object. More... | |
| uel_closure_t | uel_func_pipeline (uel_pipeline_t *pipeline) |
| Wraps a pipeline in a closure. More... | |
| uel_closure_t | uel_func_conditional (uel_conditional_t *conditional) |
| Wraps a conditional in a closure. More... | |
| uel_closure_t | uel_func_foreach (uel_closure_t *closure) |
Wraps a closure in a foreach construct. More... | |
| uel_closure_t | uel_func_map (uel_closure_t *closure) |
Wraps a closure in a map construct. More... | |
| uel_closure_t | uel_func_find (uel_closure_t *closure) |
Wraps a closure in a find construct. More... | |
| uel_closure_t | uel_func_count (uel_closure_t *closure) |
Wraps a closure in a count construct. More... | |
| uel_closure_t | uel_func_all (uel_closure_t *closure) |
Wraps a closure in a all construct. More... | |
| uel_closure_t | uel_func_none (uel_closure_t *closure) |
Wraps a closure in a none construct. More... | |
| uel_closure_t | uel_func_any (uel_closure_t *closure) |
| Wraps a closure in a all construct. More... | |
Contains helpers for composing and augumenting closures.
-| uel_closure_t uel_func_all | -( | -uel_closure_t * | -closure | ) | -- |
Wraps a closure in a all construct.
Creates a new closure based on a supplied closure. This new closure accepts an uel_iterator_t as parameter and applies the supplied closure to each element yielded by this iterator.
If all enumerate elements cause the supplied closure to return true, this new closure also returns true. Otherwise, it returns false.
| closure | The test to be applied against each enumerated element |
| uel_closure_t uel_func_any | -( | -uel_closure_t * | -closure | ) | -- |
Wraps a closure in a all construct.
-Creates a new closure based on a supplied closure. This new closure accepts an uel_iterator_t as parameter and applies the supplied closure to each element yielded by this iterator.
If any enumerate elements cause the supplied closure to return true, this new closure also returns true. Otherwise, it returns false.
| closure | The test to be applied against each enumerated element |
| uel_closure_t uel_func_conditional | -( | -uel_conditional_t * | -conditional | ) | -- |
Wraps a conditional in a closure.
-This function wraps a conditional in a closure. When invoked, the closure's parameters will be forwarded to the conditional. Also, the conditional's returned value will be returned from the closure.
-| conditional | The conditional to be wrapped |
| uel_closure_t uel_func_count | -( | -uel_closure_t * | -closure | ) | -- |
Wraps a closure in a count construct.
Creates a new closure based on a supplied closure. This new closure accepts an uel_iterator_t as parameter and applies the supplied closure to each element yielded by this iterator.
This new closure counts the number of enumerated elements that caused the test closure to return true.
| closure | The test to be applied against each enumerated element |
| uel_closure_t uel_func_find | -( | -uel_closure_t * | -closure | ) | -- |
Wraps a closure in a find construct.
Creates a new closure based on a supplied closure. This new closure accepts an uel_iterator_t as parameter and applies the supplied closure to each element yielded by this iterator.
When some enumerated element causes the supplied closure to return true, its address is returned by the new closure.
-| closure | The test to be applied against each enumerated element |
NULL. | uel_closure_t uel_func_foreach | -( | -uel_closure_t * | -closure | ) | -- |
Wraps a closure in a foreach construct.
Creates a new closure based on a supplied closure. When invoked, this new closure takes an uel_iterator_t for parameter and yields each element in it to the supplied closure.
| closure | A reference to the closure to be wrapped |
| uel_closure_t uel_func_map | -( | -uel_closure_t * | -closure | ) | -- |
Wraps a closure in a map construct.
Creates a new closure based on a supplied closure. This new closure takes an uel_func_mapper_t for parameter describing the mapping relation between elements yielded from an iterator and a region of memory.
When invoked, this new closure passes each element enumerated by this mapper as parameter to the supplied closure and stores its returned value sequentially in the destination area. It then returns the destination address.
-See uel_iterator_map().
| closure | A reference to the closure to be wrapped |
| void uel_func_mapper_init | -( | -uel_func_mapper_t * | -mapper, | -
| - | - | uel_iterator_t * | -iterator, | -
| - | - | void ** | -destination, | -
| - | - | size_t | -limit | -
| - | ) | -- |
Initialises a mapper object.
-| mapper | The mapper instance to be initialised |
| iterator | The iterator responsible for enumerating elements |
| destination | An array of void pointers to where elements will be mapped |
| limit | The maximum size of elements that can be mapped |
| uel_closure_t uel_func_none | -( | -uel_closure_t * | -closure | ) | -- |
Wraps a closure in a none construct.
Creates a new closure based on a supplied closure. This new closure accepts an uel_iterator_t as parameter and applies the supplied closure to each element yielded by this iterator.
If all enumerate elements cause the supplied closure to return false, this new closure also returns true. Otherwise, it returns false.
| closure | The test to be applied against each enumerated element |
| uel_closure_t uel_func_pipeline | -( | -uel_pipeline_t * | -pipeline | ) | -- |
Wraps a pipeline in a closure.
-This function wraps a pipeline in a closure. When invoked, the closure's parameters will be forwarded to the pipeline. Also, the pipeline's returned value will be returned from the closure.
-| pipeline | The pipeline to be wrapped |
- 1.8.17
-
-
-
diff --git a/docs/html/functional_8h__incl.map b/docs/html/functional_8h__incl.map
deleted file mode 100644
index d43aecb..0000000
--- a/docs/html/functional_8h__incl.map
+++ /dev/null
@@ -1,8 +0,0 @@
-
diff --git a/docs/html/functional_8h__incl.md5 b/docs/html/functional_8h__incl.md5
deleted file mode 100644
index af8dbff..0000000
--- a/docs/html/functional_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-95171197af7a96b706c6fb74b3843148
\ No newline at end of file
diff --git a/docs/html/functional_8h__incl.png b/docs/html/functional_8h__incl.png
deleted file mode 100644
index b85eaa8..0000000
Binary files a/docs/html/functional_8h__incl.png and /dev/null differ
diff --git a/docs/html/functional_8h_source.html b/docs/html/functional_8h_source.html
deleted file mode 100644
index 3fa691a..0000000
--- a/docs/html/functional_8h_source.html
+++ /dev/null
@@ -1,139 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/functions.html b/docs/html/functions.html
deleted file mode 100644
index 9fdb9b0..0000000
--- a/docs/html/functions.html
+++ /dev/null
@@ -1,401 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
deleted file mode 100644
index 7f52164..0000000
--- a/docs/html/functions_vars.html
+++ /dev/null
@@ -1,401 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/globals.html b/docs/html/globals.html
deleted file mode 100644
index 06f1483..0000000
--- a/docs/html/globals.html
+++ /dev/null
@@ -1,554 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html
deleted file mode 100644
index c024530..0000000
--- a/docs/html/globals_defs.html
+++ /dev/null
@@ -1,141 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/globals_enum.html b/docs/html/globals_enum.html
deleted file mode 100644
index 61ebe77..0000000
--- a/docs/html/globals_enum.html
+++ /dev/null
@@ -1,87 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/globals_eval.html b/docs/html/globals_eval.html
deleted file mode 100644
index 5ec3c9c..0000000
--- a/docs/html/globals_eval.html
+++ /dev/null
@@ -1,84 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/globals_func.html b/docs/html/globals_func.html
deleted file mode 100644
index a22dd0d..0000000
--- a/docs/html/globals_func.html
+++ /dev/null
@@ -1,437 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/globals_type.html b/docs/html/globals_type.html
deleted file mode 100644
index f8d049d..0000000
--- a/docs/html/globals_type.html
+++ /dev/null
@@ -1,105 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/graph_legend.html b/docs/html/graph_legend.html
deleted file mode 100644
index 970b17d..0000000
--- a/docs/html/graph_legend.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
This page explains how to interpret the graphs that are generated by doxygen.
-Consider the following example:
This will result in the following graph:
-
The boxes in the above graph have the following meaning:
-The arrows have the following meaning:
-
- 1.8.17
-
-
-
diff --git a/docs/html/graph_legend.md5 b/docs/html/graph_legend.md5
deleted file mode 100644
index 8fcdccd..0000000
--- a/docs/html/graph_legend.md5
+++ /dev/null
@@ -1 +0,0 @@
-f51bf6e9a10430aafef59831b08dcbfe
\ No newline at end of file
diff --git a/docs/html/graph_legend.png b/docs/html/graph_legend.png
deleted file mode 100644
index 83dfada..0000000
Binary files a/docs/html/graph_legend.png and /dev/null differ
diff --git a/docs/html/index.html b/docs/html/index.html
deleted file mode 100644
index 5c9ecc6..0000000
--- a/docs/html/index.html
+++ /dev/null
@@ -1,1302 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A fast and lightweight event loop aimed at embedded platforms in C99.
-µEvLoop is a microframework build around a lightweight event loop. It provides the programmer the building blocks to put together async, interrupt-based systems.
-µEvLoop is loosely inspired on the Javascript event loop and aims to provide a similar programming model. Many similar concepts, such as events and closures are included. It is aimed at environments with very restricted resources, but can be run on all kinds of platforms.
-µEvLoop is in its early days and the API may change at any moment for now. Although it's well tested, use it with caution. Anyway, feedback is most welcome.
-The API documentation is automatically generated by Doxygen. Find it here.
-Tests are written using a simple set of macros. To run them, execute make test.
Please note that the makefile shipped is meant to be run in modern Linux systems. Right now, it makes use of bash commands and utilities as well as expects libSegFault.so to be in a hardcoded path.
If this doesn't fit your needs, edit it as necessary.
-To generate code coverage reports, run make coverage. This requires gcov, lcov and genhtml to be on your PATH. After running, the results can be found on uevloop/coverage/index.html.
These data structures are used across the whole framework. They can also be used by the programmer in userspace as required.
-All core data structures are unsafe. Be sure to wrap access to them in critical sections if you mean to share them amongst contexts asynchronous to each other.
-A closure is an object that binds a function to some context. When invoked with arbitrary parameters, the bound function is called with both context and parameters available. With closures, some very powerful programming patterns, as functional composition, become way easier to implement.
-Closures are very light and it is often useful to pass them around by value.
-Closures take the context and parameters as a void pointers and return the same. This is meant to make possible to pass and return complex objects from them.
-At many times, however, the programmer may find the values passed/returned are small and simple (i.e.: smaller than a pointer). If so, it is absolutely valid to cast from/to a uintptr_t or other data type known to be at most the size of a pointer. The above example does that to avoid creating unnecessary object pools or allocating dynamic memory.
Circular queues are fast FIFO (first-in-first-out) structures that rely on a pair of indices to maintain state. As the indices are moved forward on push/pop operations, the data itself is not moved at all.
-The size of µEvLoop's circular queues are required to be powers of two, so it is possible to use fast modulo-2 arithmetic. As such, on queue creation, the size must be provided in its log2 form.
-FORGETTING TO SUPPLY THE QUEUE'S SIZE IN LOG2 FORM MAY CAUSE THE STATIC ALLOCATION OF GIANT MEMORY POOLS
-Circular queues store void pointers. As it is the case with closures, this make possible to store complex objects within the queue, but often typecasting to an smaller value type is more useful.
-On embedded systems, hardware resources such as processing power or RAM memory are often very limited. As a consequence, dynamic memory management can become very expensive in both aspects.
-Object pools are statically allocated arrays of objects whose addresses are stored in a queue. Whenever the programmer needs a object in runtime, instead of dynamically allocating memory, it is possible to simply pop an object pointer from the pool and use it away.
-Because object pools are statically allocated and backed by circular queues, they are very manageable and fast to operate.
-µEvLoop ships a simple linked list implementation that holds void pointers, as usual.
-Containers are objects that encapsulate declaration, initialisation and manipulation of core data structures used by the framework.
-They also encapsulates manipulation of these data structures inside critical sections, ensuring safe access to shared resources across the system.
-The syspools component is a container for the system internal object pools. It contains pools for events and linked list nodes used by the core components.
The system pools component is meant to be internally operated only. The only responsibility of the programmer is to allocate, initialise and provide it to other core components.
-To configure the size of each pool created, edit include/uevloop/config.h.
The sysqueues component contains the necessary queues for sharing data amongst the core components. It holds queues for events in differing statuses.
As is the case with system pools, the sysqueues component should not be directly operated by the programmer, except for declaration and initialisation.
Configure the size of each queue created in include/uevloop/config.h.
The application component is a convenient top-level container for all the internals of an µEvLoop'd app. It is not necessary at all but contains much of the boilerplate in a typical application.
It also proxies functions to the event loop and scheduler components, serving as a single point entry for the system operation.
The following code is a realistic minimal setup of the framework. ```c #include <uevloop/system/containers/application.h> #include <stdint.h>
-static volatile uint32_t counter = 0; static uel_application_t my_app;
-// 1 kHz timer void my_timer_isr(){ my_timer_isr_flag = 0; uel_app_update_timer(&my_app, ++counter); }
-int main (int argc, char *argv[]){ uel_app_init(&my_app);
-// From here, the programmer can: // - Schedule timers with uel_app_run_later or uel_app_run_at_intervals // - Enqueue closures with uel_app_enqueue_closure // - Set up observers with uel_app_observe // - Listen for signals set at other places
while(1){
- uel_app_tick(&my_app); }
return 0; }
The scheduler component accepts input of closures and scheduling info an then turns it into a timer event. This timer is then inserted in a timer list, which is sorted by each timer's due time.
The scheduler must be fed regularly to work. It needs both an update on the running time as an stimulus to process enqueued timers. Ideally, a hardware timer will be consistently incrementing a counter and feeding it at an ISR while in the main loop the scheduler is oriented to process its queue.
When the function uel_sch_manage_timers is called, two things happen:
schedule_queue is flushed and every timer in it is scheduled accordingly;event_queue, where they will be further collected and processed.Events are messages passed amongst the system internals that coordinate what tasks are to be run, when and in which order. Usually, the programmer don't have to interact directly with events, being timer events and observers the only exceptions to this. The functions uel_sch_run_later and uel_sch_run_at_intervals return a uel_event_t *. With this handle, it is possible to pause and resume or even completely cancel a timer event.
```C #include <stddef.h>
-uel_event_t *timer = uel_sch_run_at_intervals(&scheduler, 100, false, print_one, NULL);
-// The event will be put on a hold queue in the scheduler uel_event_timer_pause(timer);
-
// The event will be rescheduled on the scheduler uel_event_timer_resume(timer);
-// The event will be ignored by the scheduler and destroyed at the event loop uel_event_timer_cancel(timer);
The event loop is mean to behave as a run-to-completion task scheduler. Its uel_evloop_run function should be called as often as possible as to minimise execution latency. Each execution of uel_evloop_run is called a runloop .
The only way the programmer interacts with it, besides creation / initialisation, is by enqueuing hand-tailored closures directly, but other system components operate on the event loop behind the stage.
-Any closure can be enqueued multiple times.
-WARNING! uel_evloop_run is the single most important function within µEvLoop. Almost every other core component depends on the event loop and if this function is not called, the loop won't work at all. Don't ever let it starve.
The event loop can be instructed to observe some arbitrary volatile value and react to changes in it.
-Because observers are completely passive, they are ideal for triggering side-effects from ISRs without any latency. However, each observer set does incur extra latency during runloops, as the observed value must be continuously polled.
-```c static volatile uintptr_t adc_reading = 0;
-void my_adc_isr(){ adc_reading = my_adc_buffer; my_adc_isr_flag = 0; }
-static void *process_adc_reading(void *context, void *params){ uintptr_t value = (uintptr_t)params; // Do something with value
return NULL; } uel_closure_t processor = uel_closure_create(process_adc_reading, NULL);
-// This ensures each runloop the adc_reading variable is polled and, in case // of changes to it, the processor closure is called with its new value as // parameter. uel_event_t *observer = uel_evloop_observe(&loop, &adc_reading, &processor);
// When an observer isn't needed anymore, it can be disposed of to release any // used system resources. // DON'T use an observer after it has been cancelled. uel_event_observer_cancel(observer).
Please note the listener function will not be executed immediately, despite what this last snippet can lead to believe. Internally, each closure will be sent to the event loop and only when it runs will the closures be invoked.
-You can also unlisten for events. This will prevent the listener returned by a uel_signal_listen() or uel_signal_listen_once() operation to have its closure invoked when the event loop performs the next runloop. Additionally, said listener will be removed from the signal vector on such opportunity.
Promises are data structures that bind an asynchronous operation to the possible execution paths that derive from its result. They are heavily inspired by Javascript promises.
-Promises allow for very clean asynchronous code and exceptional error handling.
-All promises must be created at a store, to where they will come back once destroyed. A promise store encapsulates object pools for promises and segments, the two composing pieces for promise operation.
-Promise store need access to two object pools, one for promises and one for segments.
As mentioned above, promises and segments are the two building blocks for composing asynchronous chains of events. Promises represent the asynchronous operation per se and segments are the synchronous processing that occurs when a promise settles.
-Settling a promise means transitioning it into either resolved or rejected states which respectively indicate success or error of the asynchronous operation, optionally assigning a meaningful value to the promise.
-There are two necessary pieces for creating a promise: a store and a constructor closure that starts the asynchronous operation.
-When the promise is created, start_some_async is invoked immediately, taking the promise pointer as parameter.
On creation, promises are in the pending state. This means its asynchronous operation has not been completed yet and the promise does not hold any meaningful value.
-Once the operation is completed (and this can also be synchronously done from inside the constructor closure), there are two functions for signalling either success or failure of the asynchronous operation:
-Once a promise is settled, it holds a value that can be accessed via promise->value.
Segments represent the synchronous phase that follows a promise settling. They contain two closures, one for handling resolved promises and one for handling rejected promises. Either one is chosen at runtime, depending on the settled state of the promise, and is invoked with the promise as parameter.
-Depending on the promise state, attaching segments have different effects. When a promise is pending, attached segments just get enqueued for execution once the promise is settled. Should the promise be already settled, attached segments get processed immediately instead.
-The uel_promise_after() function takes two closures as parameters. This is useful for splitting the execution path in two mutually exclusive routes depending on the settled state of the promise.
There are three other functions for enqueuing segments. They can be used for attaching segments that only produce effects on specific settled states or attaching the same closure to both states:
-Any number of segments can be attached to some promise. They will be either processed immediately, in case the promise is already settled, or enqueued for processing upon settling in the future. Regardless, attached segments are always processed in registration order.
-Chaining segments is useful because segments have the ability to commute between execution paths through promise resettling. To resettle a promise means changing its state and value.
-This builds a segment chain attached to promise p1. Each segment added describes one synchronous step to be executed for each of the two settled states.
Segments are processed sequentially, from first to last, starting with the closure relative to the state the promise was settled as. The following table illustrates this chain:
-| State | Segment 1 | Segment 2 | Segment 3 |
|---|---|---|---|
| resolved | store_char | nop | done |
| rejected | nop | report_error | done |
The outcome of this chain is determined upon settling. For example, given the following resolution:
-The first closure invoked is store_char, in segment 1. In the closure function, the test condition promise->value <= 255 is true, so the closure proceeds to store its value in the c1 variable.
As the promise remains resolved, it advances to segment 2, where it finds a nop (no-operation). This is due to the segment being attached via uel_promise_catch.
The promise then advances to segment 3, where it finds the done closure. The process then ends and the promise retains its state and value (UEL_PROMISE_RESOLVED and (void *)10 in this case). By then, c1 holds (char)10 and ‘operation done with state 'resolved’` is printed.
If instead the promise was resolved as:
Then the test condition promise->value <= 255 would have failed. The store_char would then skip storing the value and would rather resettle the promise as rejected, with some error message as value. This effectively commutes the execution path to the rejected branch.
Once the store_char returns, as the promise is now rejected, the report_error closure is invoked and ‘promise was rejected with error 'Value too big’is printed. Thedoneclosure is then invoked and printsoperation done with state 'rejected'`.
Similarly, if instead the promise had been rejected as:
Segment 1 would be ignored, report_error would be invoked and print ‘promise was rejected with error 'Asynchronous operation failed’and, at segment 3,donewould be invoked and printoperation done with state 'rejected'`.
Resettling can also be used for recovering from errors if it commutes back to resolved state. This constitutes an excellent exception system that allows errors raised in loose asynchronous operations to be rescued consistently. Even exclusively synchronous processes can benefit from this error rescuing system.
As a last note, segments can also resettle a promise as UEL_PROMISE_PENDING. This halts the synchronous stage immediately, leaving any unprocessed segments in place. This phase can be restarted by either resolving or rejecting the promise again.
Promises can be nested into each other, allowing for complex asynchronous operations to compose a single segment chain. This provides superb flow control for related asynchronous operations that would otherwise produce a lot of spaghetti code.
-Whenever a promise segment returns any non-null value, it is cast to a promise pointer. The original promise then transitions back to pending state and awaits for the returned promise to settle. Once this new promise is settled, the original promise is resumed with whatever state and value the new promise was settled as.
For instance, suppose the programmer is programming an MCU that possesses an ADC with an arbitrarily long buffer and a DMA channel. The program must start the ADC, which will sample N times and store it in its buffer. After N samples have been taken, the DMA channel must be instructed to move it out of the ADC buffer into some memory-mapped buffer, where it will be processed.
This could be easily accomplished with signals or callbacks, but would eventually lead to confusing and discontinuous code. With nested promises, however, it is easy to describe the whole process into one single chain.
-Suppose this is the implementation for the DMA and ADC modules:
-Implementing the project requirements is this simple:
-Note that, in the above example, promises are resolved synchronously inside the ISR's. This may be not desirable due to performance reasons, but can be easily improved by enqueueing a closure that resolves nested promises into the event loop.
-To destroy a promise, call uel_promise_destroy(). This will release all segments and then the promise itself. Settling a promise after it has been destroyed is undefined behaviour.
Because settling and destroying promises are so frequent, there are helper functions that emit closures that automate this work:
-Modules are independent units of behaviour, self-contained and self-allocated, with clear lifecycle hooks, interface and dependencies. They enforce separation of concerns and isolation by making clear how your code interacts with the rest of the application.
-Modules are absolutely optional and very thin on the library side. They are basically a convention of how to write code in a fashion that works well with µEvLoop.
-Modules can serve as a variety of purposes:
Modules are operated by the application component. It is responsible for loading, configuring and launching each module.
There are two method for injecting a registered module: parametrised injection and ad-hoc injection. Each is adequate for a different situation:
-Parametrised dependencies are dependencies that are supplied during module construction.
-Given the following module header:
The application loading procedure would be:
```c // File: main.c
-uel_module_t *modules[MY_APP_MODULE_COUNT];
-modules[MY_MODULE] = my_module(&my_app);
-// Injects parametrised dependencies name and other_module modules[MY_GREETER] = my_greeter(&my_app, "King Kong", (my_module_t *)modules[MY_MODULE]);
uel_app_load(&my_app, modules, MY_APP_MODULE_COUNT)
While Ad-hoc injections seem easier, they make more difficult to know on which modules some particular piece of code depends on. Also, because they require the modules to already be loaded into the registry, they cannot be used during the configuration phase.
-Iterators are abstractions on arbitrary collections of items. They provide a uniform interface for yielding each element in the iterated collection, disregarding implementation details of such collection.
-There are two iterator specialisations shipped with µEvLoop:
-Iterators live entirely on an embedded function pointer, next. It is responsible by yielding a pointer to each element in the collection.
```c // cast to generic iterator uel_iterator_t *iterator = (uel_iterator_t *)
-// when supplied with NULL as parameter to next, yields // the first element in the collection int *current = NULL;
while(true){ current = (int *)iterator->next(iterator, (void *)current); if(current != NULL){ // do something }else break; // when there are no more elements , yields NULL } ```
Besides manually operating an iterator, there are several iteration helpers that automatise work.
-```c #include <uevloop/utils/closure.h>
-void *accumulate(void *context, void *params){ uintptr_t *acc = (uintptr_t *)context; uintptr_t num = *(uintptr_t *)params; *acc += num; return (void *)true; // required; returning false is equivalent to a break }
uintptr_t acc = 0; uel_closure_t acumulate_into_acc = uel_closure_create(accumulate, (void *)&acc);
-uel_iterator_foreach(iterator, &accumulate_into_acc); // if iterator is the same array iterator defined previously, // acc == 15
Note that base is required to be the first member in your custom iterator structure. That way, a pointer to your iterator can be safely cast to uel_iterator_t * forth and back.
Conditionals are functional switches in the form of a tuple of closures <test, if_true, if_false>.
When applied to some input, this input is submitted to the test closure. If it returns true, if_true closure is invoked, otherwise, if_false is invoked. All closures take the same input as arguments.
Pipelines are sequences of closures whose outputs are connected to the next closure's input.
-When applied to some input, this input is passed along each closure, being transformed along the way. Applying a pipeline returns the value returned by the last closure in it.
-Iterators, conditionals and pipelines are objects associated with synchronous operations.
-To make more suitable to asynchronous contexts, there are numerous helpers that can abstract some of their operational details and export them into portable closures.
-Please read the docs to find out more about them.
-Automatic pools are wrappers objects that enhance the abilities of object pools. They allow constructors and destructors to be attached and, instead of yielding bare pointers, yield uel_autoptr_t automatic pointers.
Automatic pointers are objects that associate some object to the pool it is from, making it trivial to destroy the object regardless of access to its source. An automatic pointer issued to an object of type T can be safely cast to T**. Casting to any other pointer type is undefined behaviour.
Automatic pools are created and initialised in very similar ways to object pools:
-After an automatic pool has been created, it can allocate and deallocate objects, just like object pools.
-It is possible to attach a constructor and a destructor to some automatic pool. This are closures that will be invoked upon object allocation and deallocation, taking a bare pointer to the object being operated on.
-µEvLoop is meant to run baremetal, primarily in simple single-core MCUs. That said, nothing stops it from being employed as a side library in RTOSes or in full-fledged x86_64 multi-threaded desktop applications.
-Communication between asynchronous contexts, such as ISRs and side threads, is done through some shared data structures defined inside the library's core components. As whenever dealing with non-atomic shared memory, there must be synchronisation between accesses to these structures as to avoid memory corruption.
-µEvLoop does not try to implement a universal locking scheme fit for any device. Instead, some generic critical section definition is provided.
-By default, critical sections in µEvLoop are a no-op. They are provided as a set of macros that can be overriden by the programmer to implement platform specific behaviour.
-For instance, while running baremetal it may be only necessary to disable interrupts to make sure accesses are synchronised. On a RTOS multi-threaded environment, on the other hand, it may be necessary to use a mutex.
-There are three macros that define critical section implementation:
-UEL_CRITICAL_SECTION_OBJ_TYPE
If needed, a global critical section object can be declared. If this macro is defined, this object will be available to any critical section under the symbol uel_critical_section.
The UEL_CRITICAL_SECTION_OBJ_TYPE macro defines the type of the object. It is the programmer's responsibility to declare, globally allocate and initialise the object.
UEL_CRITICAL_ENTER
Enters a new critical section. From this point until the critical section exits, no other thread or ISR may attempt to access the system's shared memory.
-UEL_CRITICAL_EXIT
Exits the current critical section. After this is called, any shared memory is allowed to be claimed by some party.
-I often work with small MCUs (8-16bits) that simply don't have the necessary power to run a RTOS or any fancy scheduling solution. Right now I am working on a new commercial project and felt the need to build something by my own. µEvLoop is my bet on how a modern, interrupt-driven and predictable embedded application should be. I am also looking for a new job and needed to improve my portfolio.
-
- 1.8.17
-
-
-
diff --git a/docs/html/iterator_8h.html b/docs/html/iterator_8h.html
deleted file mode 100644
index 17e3813..0000000
--- a/docs/html/iterator_8h.html
+++ /dev/null
@@ -1,635 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines iterators, structures and functions suitable for enumerating other data structures. -More...
-
Go to the source code of this file.
--Data Structures | |
| struct | uel_iterator_t |
| Iterators are data structures that wrap arbitrary collections of data and define ways of enumerating them. More... | |
| struct | uel_iterator_array_t |
| A specialised iterator suitable for iterating over arrays of arbitrary data. More... | |
-Macros | |
| #define | UEL_ITERATOR_MAP_BOUNDLESS UINT_MAX |
-Typedefs | |
| typedef uel_iterator_t | uel_iterator_llist_t |
Alias to uel_iterator_t. Iterator suitable to traverse linked lists. More... | |
-Functions | |
| bool | uel_iterator_foreach (uel_iterator_t *iterator, uel_closure_t *closure) |
| Applies a closure to an enumerable collection. More... | |
| size_t | uel_iterator_map (uel_iterator_t *iterator, uel_closure_t *closure, void **destination, size_t limit) |
| Applies a closure to an enumerable collection and stores its results. More... | |
| void * | uel_iterator_find (uel_iterator_t *iterator, uel_closure_t *closure) |
| Finds the first element enumerated by an iterator that passes the supplied test. More... | |
| size_t | uel_iterator_count (uel_iterator_t *iterator, uel_closure_t *closure) |
| Counts elements enumerated by an iterator that pass the supplied test. More... | |
| bool | uel_iterator_all (uel_iterator_t *iterator, uel_closure_t *closure) |
| Determines whether all elements enumerated by an iterator pass the supplied test or not. More... | |
| bool | uel_iterator_none (uel_iterator_t *iterator, uel_closure_t *closure) |
| Determines whether all elements enumerated by an iterator fail the supplied test or not. More... | |
| bool | uel_iterator_any (uel_iterator_t *iterator, uel_closure_t *closure) |
| Determines whether any elements enumerated by an iterator pass the supplied test or not. More... | |
| void * | uel_iterator_array_next (uel_iterator_array_t *iterator, void *last) |
| Yields elements in a array. More... | |
| uel_iterator_array_t | uel_iterator_array_create (void *collection, size_t count, size_t size) |
| Creates a new array iterator. More... | |
| void * | uel_iterator_llist_next (uel_iterator_t *iterator, void *last) |
| Yields elements in a linked list. More... | |
| uel_iterator_llist_t | uel_iterator_llist_create (uel_llist_t *list) |
| Creates a new linked list iterator. More... | |
Defines iterators, structures and functions suitable for enumerating other data structures.
-| #define UEL_ITERATOR_MAP_BOUNDLESS UINT_MAX | -
Defines the maximum possible iteration limit for the uel_iterator_map() function.
| typedef uel_iterator_t uel_iterator_llist_t | -
Alias to uel_iterator_t. Iterator suitable to traverse linked lists.
Because when traversing a linked list we need only know one element to know the next one, there is no need to store any additional state in linked list iterators.
- -| bool uel_iterator_all | -( | -uel_iterator_t * | -iterator, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Determines whether all elements enumerated by an iterator pass the supplied test or not.
-| iterator | The iterator that enumerates the elements of some collection |
| closure | The test to be applied against each enumerated element |
| bool uel_iterator_any | -( | -uel_iterator_t * | -iterator, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Determines whether any elements enumerated by an iterator pass the supplied test or not.
-| iterator | The iterator that enumerates the elements of some collection |
| closure | The test to be applied against each enumerated element |
| uel_iterator_array_t uel_iterator_array_create | -( | -void * | -collection, | -
| - | - | size_t | -count, | -
| - | - | size_t | -size | -
| - | ) | -- |
Creates a new array iterator.
-| collection | The array to be enumerated |
| count | The number of elements in this array |
| size | The size of each element in the array |
| void* uel_iterator_array_next | -( | -uel_iterator_array_t * | -iterator, | -
| - | - | void * | -last | -
| - | ) | -- |
Yields elements in a array.
-| iterator | The iterator thar enumerates the elements in the target array |
| last | The last element yielded. If NULL, returns the first element. |
NULL. | size_t uel_iterator_count | -( | -uel_iterator_t * | -iterator, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Counts elements enumerated by an iterator that pass the supplied test.
-| iterator | The iterator that enumerates the elements of some collection |
| closure | The test to be applied against each enumerated element |
| void* uel_iterator_find | -( | -uel_iterator_t * | -iterator, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Finds the first element enumerated by an iterator that passes the supplied test.
-| iterator | The iterator that enumerates the elements of some collection |
| closure | The test to be applied against each enumerated element |
| bool uel_iterator_foreach | -( | -uel_iterator_t * | -iterator, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Applies a closure to an enumerable collection.
-| iterator | The iterator that enumerates the elements of some collection |
| closure | The closure to be invoked with each element in the enumerated collection as parameter. If this closure returns false, the iteration will be halted. |
false. | uel_iterator_llist_t uel_iterator_llist_create | -( | -uel_llist_t * | -list | ) | -- |
Creates a new linked list iterator.
-| list | The linked list to be enumerated |
| void* uel_iterator_llist_next | -( | -uel_iterator_t * | -iterator, | -
| - | - | void * | -last | -
| - | ) | -- |
Yields elements in a linked list.
-| iterator | The iterator thar enumerates the elements in the target list |
| last | The last element yielded. If NULL, returns the first element. |
NULL. | size_t uel_iterator_map | -( | -uel_iterator_t * | -iterator, | -
| - | - | uel_closure_t * | -closure, | -
| - | - | void ** | -destination, | -
| - | - | size_t | -limit | -
| - | ) | -- |
Applies a closure to an enumerable collection and stores its results.
-This function takes an iterator that enumerates elements in a collection and yields each one to a closure. The return value of each closure call is stored in an array.
-| iterator | The iterator that enumerates the elements of some collection |
| closure | The closure to be invoked with each element in the enumerated collection ad parameter. |
| destination | The destination of the data produced by the invoked closure. This must be an array of void pointers large enough to store all produced data |
| limit | The maximum size of the destination buffer. If collection is larger than this array, in elements, it will not be iterated entirely, only up to the limitth element. |
| bool uel_iterator_none | -( | -uel_iterator_t * | -iterator, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Determines whether all elements enumerated by an iterator fail the supplied test or not.
-| iterator | The iterator that enumerates the elements of some collection |
| closure | The test to be applied against each enumerated element |
- 1.8.17
-
-
-
diff --git a/docs/html/iterator_8h__dep__incl.map b/docs/html/iterator_8h__dep__incl.map
deleted file mode 100644
index bb9bec5..0000000
--- a/docs/html/iterator_8h__dep__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/iterator_8h__dep__incl.md5 b/docs/html/iterator_8h__dep__incl.md5
deleted file mode 100644
index 3a81273..0000000
--- a/docs/html/iterator_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-d1aa05b9f71b76b45f7b2fda325e2fcf
\ No newline at end of file
diff --git a/docs/html/iterator_8h__dep__incl.png b/docs/html/iterator_8h__dep__incl.png
deleted file mode 100644
index 4f878b1..0000000
Binary files a/docs/html/iterator_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/iterator_8h__incl.map b/docs/html/iterator_8h__incl.map
deleted file mode 100644
index 30fe778..0000000
--- a/docs/html/iterator_8h__incl.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/iterator_8h__incl.md5 b/docs/html/iterator_8h__incl.md5
deleted file mode 100644
index 945f58d..0000000
--- a/docs/html/iterator_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-952aa586340a674cafb3671faa6525af
\ No newline at end of file
diff --git a/docs/html/iterator_8h__incl.png b/docs/html/iterator_8h__incl.png
deleted file mode 100644
index dc0b99a..0000000
Binary files a/docs/html/iterator_8h__incl.png and /dev/null differ
diff --git a/docs/html/iterator_8h_source.html b/docs/html/iterator_8h_source.html
deleted file mode 100644
index 315f34a..0000000
--- a/docs/html/iterator_8h_source.html
+++ /dev/null
@@ -1,151 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/jquery.js b/docs/html/jquery.js
deleted file mode 100644
index 103c32d..0000000
--- a/docs/html/jquery.js
+++ /dev/null
@@ -1,35 +0,0 @@
-/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */
-!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines a simple implementation of linked lists and functions to manipulate it. -More...
-#include "uevloop/utils/closure.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_llist_node_t |
| Defines a node of the linked list. Holds a void pointer. More... | |
| struct | uel_llist_t |
| Defines a linked list. If it is empty, head == tail == NULL. Pushing or popping from both the head or tail is always O(1). More... | |
-Functions | |
| void | uel_llist_init (uel_llist_t *list) |
| Initialised a linked list. More... | |
| void | uel_llist_push_head (uel_llist_t *list, uel_llist_node_t *node) |
| Pushes a node to the head of the list. More... | |
| void | uel_llist_push_tail (uel_llist_t *list, uel_llist_node_t *node) |
| Pushes a node to the tail of the list. More... | |
| uel_llist_node_t * | uel_llist_pop_head (uel_llist_t *list) |
| Pops a node from the head of the list. More... | |
| uel_llist_node_t * | uel_llist_pop_tail (uel_llist_t *list) |
| Pops a node from the tail of the list. More... | |
| uel_llist_node_t * | uel_llist_peek_head (uel_llist_t *list) |
| Peeks the element at the head of the list. More... | |
| uel_llist_node_t * | uel_llist_peek_tail (uel_llist_t *list) |
| Peeks the element at the tail of the list. More... | |
| bool | uel_llist_remove (uel_llist_t *list, uel_llist_node_t *node) |
| Removes a node from the queue. More... | |
| uel_llist_t | uel_llist_remove_while (uel_llist_t *list, uel_closure_t *should_remove) |
| Splits a list in two. The rupture point is determined by the supplied closure. More... | |
| void | uel_llist_insert_at (uel_llist_t *list, uel_llist_node_t *node, uel_closure_t *should_insert) |
| Scans a list until it finds a suitable spot to insert the provided node. More... | |
Defines a simple implementation of linked lists and functions to manipulate it.
-| void uel_llist_init | -( | -uel_llist_t * | -list | ) | -- |
Initialised a linked list.
-| list | The list to be initialised. It will be empty after initialisation. |
| void uel_llist_insert_at | -( | -uel_llist_t * | -list, | -
| - | - | uel_llist_node_t * | -node, | -
| - | - | uel_closure_t * | -should_insert | -
| - | ) | -- |
Scans a list until it finds a suitable spot to insert the provided node.
-This function iterates the linked list invoking the supplied closure until it returns true. The supplied node is then inserted at this position.
-The should_insert closure will be invoked for each pair of node addresses in the range [NULL, &NODE_1, &NODE_2, ..., &NODE_N, NULL] as parameter. When it finds a suitable position, it must return true.
| list | The list to insert the node at |
| node | The node to be inserted |
| should_insert | A closure that returns whether the node ought to be inserted at the current position. The closure function must unpack the closure parameters to a uel_llist_node_t **[2] and return a boolean. |
| uel_llist_node_t* uel_llist_peek_head | -( | -uel_llist_t * | -list | ) | -- |
Peeks the element at the head of the list.
-| list | The list from where the node will be peeked |
| uel_llist_node_t* uel_llist_peek_tail | -( | -uel_llist_t * | -list | ) | -- |
Peeks the element at the tail of the list.
-| list | The list from where the node will be peeked |
| uel_llist_node_t* uel_llist_pop_head | -( | -uel_llist_t * | -list | ) | -- |
Pops a node from the head of the list.
-| list | The list from where the node will be popped |
| uel_llist_node_t* uel_llist_pop_tail | -( | -uel_llist_t * | -list | ) | -- |
Pops a node from the tail of the list.
-| list | The list from where the node will be popped |
| void uel_llist_push_head | -( | -uel_llist_t * | -list, | -
| - | - | uel_llist_node_t * | -node | -
| - | ) | -- |
Pushes a node to the head of the list.
-| list | The list into which to insert the node |
| node | The node to be inserted. |
| void uel_llist_push_tail | -( | -uel_llist_t * | -list, | -
| - | - | uel_llist_node_t * | -node | -
| - | ) | -- |
Pushes a node to the tail of the list.
-| list | The list into which to insert the node |
| node | The node to be inserted. |
| bool uel_llist_remove | -( | -uel_llist_t * | -list, | -
| - | - | uel_llist_node_t * | -node | -
| - | ) | -- |
Removes a node from the queue.
-| list | The list from where the node will be removed |
| node | Address of the node being removed |
| uel_llist_t uel_llist_remove_while | -( | -uel_llist_t * | -list, | -
| - | - | uel_closure_t * | -should_remove | -
| - | ) | -- |
Splits a list in two. The rupture point is determined by the supplied closure.
-This function iterates the linked list invoking the provided closure for each node in it. While the closure returns true, nodes are popped from the list.
-| list | The list from where to pop nodes |
| should_remove | A closure that will be invoked taking each node as parameter. The closure should return a boolean indicating whether the node should be removed or not. |
- 1.8.17
-
-
-
diff --git a/docs/html/linked-list_8h__dep__incl.map b/docs/html/linked-list_8h__dep__incl.map
deleted file mode 100644
index a2880b2..0000000
--- a/docs/html/linked-list_8h__dep__incl.map
+++ /dev/null
@@ -1,12 +0,0 @@
-
diff --git a/docs/html/linked-list_8h__dep__incl.md5 b/docs/html/linked-list_8h__dep__incl.md5
deleted file mode 100644
index 5ce843b..0000000
--- a/docs/html/linked-list_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-f1d246f913f5566cd4f095d688e50341
\ No newline at end of file
diff --git a/docs/html/linked-list_8h__dep__incl.png b/docs/html/linked-list_8h__dep__incl.png
deleted file mode 100644
index 601e777..0000000
Binary files a/docs/html/linked-list_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/linked-list_8h__incl.map b/docs/html/linked-list_8h__incl.map
deleted file mode 100644
index 7c882b7..0000000
--- a/docs/html/linked-list_8h__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/linked-list_8h__incl.md5 b/docs/html/linked-list_8h__incl.md5
deleted file mode 100644
index 05047fc..0000000
--- a/docs/html/linked-list_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-1a1bdd1d4007500996ee0b05309c73dd
\ No newline at end of file
diff --git a/docs/html/linked-list_8h__incl.png b/docs/html/linked-list_8h__incl.png
deleted file mode 100644
index 2177760..0000000
Binary files a/docs/html/linked-list_8h__incl.png and /dev/null differ
diff --git a/docs/html/linked-list_8h_source.html b/docs/html/linked-list_8h_source.html
deleted file mode 100644
index df83f9c..0000000
--- a/docs/html/linked-list_8h_source.html
+++ /dev/null
@@ -1,142 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/menu.js b/docs/html/menu.js
deleted file mode 100644
index 433c15b..0000000
--- a/docs/html/menu.js
+++ /dev/null
@@ -1,50 +0,0 @@
-/*
- @licstart The following is the entire license notice for the
- JavaScript code in this file.
-
- Copyright (C) 1997-2017 by Dimitri van Heesch
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
- @licend The above is the entire license notice
- for the JavaScript code in this file
- */
-function initMenu(relPath,searchEnabled,serverSide,searchPage,search) {
- function makeTree(data,relPath) {
- var result='';
- if ('children' in data) {
- result+='
|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Go to the source code of this file.
--Data Structures | |
| struct | uel_module_t |
| A module is an isolated unit of behaviour with lifecycle hooks. More... | |
-Typedefs | |
| -typedef void(* | uel_module_hook_t) (struct uel_module *) |
| Defines a module hook to be called during the module lifecycle. | |
-Functions | |
| void | uel_module_init (uel_module_t *module, uel_module_hook_t config, uel_module_hook_t launch, struct uel_application *app) |
| Initialised a module. More... | |
| void | uel_module_config (uel_module_t *module) |
| Calls the configuration hook of a module. More... | |
| void | uel_module_launch (uel_module_t *module) |
| Calls the launch hook of a module. More... | |
Defines modules, isolated units of behaviour with lifecycle hooks.
-| void uel_module_config | -( | -uel_module_t * | -module | ) | -- |
Calls the configuration hook of a module.
-| module | The modules to config |
| void uel_module_init | -( | -uel_module_t * | -module, | -
| - | - | uel_module_hook_t | -config, | -
| - | - | uel_module_hook_t | -launch, | -
| - | - | struct uel_application * | -app | -
| - | ) | -- |
Initialised a module.
-| module | The module to be initialised |
| config | A module hook to be invoked during the configuration phase |
| launch | A module hook to be invoked during the launching phase |
| app | The application instante onto which this module will be loaded |
| void uel_module_launch | -( | -uel_module_t * | -module | ) | -- |
Calls the launch hook of a module.
-| module | The modules to launch |
- 1.8.17
-
-
-
diff --git a/docs/html/module_8h__dep__incl.map b/docs/html/module_8h__dep__incl.map
deleted file mode 100644
index e17cb17..0000000
--- a/docs/html/module_8h__dep__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/module_8h__dep__incl.md5 b/docs/html/module_8h__dep__incl.md5
deleted file mode 100644
index 0966591..0000000
--- a/docs/html/module_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-af60f43600ef0d7d39b399ddf1ff0d54
\ No newline at end of file
diff --git a/docs/html/module_8h__dep__incl.png b/docs/html/module_8h__dep__incl.png
deleted file mode 100644
index 5b404f5..0000000
Binary files a/docs/html/module_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/module_8h_source.html b/docs/html/module_8h_source.html
deleted file mode 100644
index cdbada0..0000000
--- a/docs/html/module_8h_source.html
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/nav_f.png b/docs/html/nav_f.png
deleted file mode 100644
index 72a58a5..0000000
Binary files a/docs/html/nav_f.png and /dev/null differ
diff --git a/docs/html/nav_g.png b/docs/html/nav_g.png
deleted file mode 100644
index 2093a23..0000000
Binary files a/docs/html/nav_g.png and /dev/null differ
diff --git a/docs/html/nav_h.png b/docs/html/nav_h.png
deleted file mode 100644
index 33389b1..0000000
Binary files a/docs/html/nav_h.png and /dev/null differ
diff --git a/docs/html/object-pool_8h.html b/docs/html/object-pool_8h.html
deleted file mode 100644
index 91d84be..0000000
--- a/docs/html/object-pool_8h.html
+++ /dev/null
@@ -1,456 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines object pools, arrays of pre-allocated objects for dynamic use. -More...
-#include "uevloop/utils/circular-queue.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_objpool_t |
| Pre-allocated memory bound to speciffic types suitable for providing dynamic object management in the stack. More... | |
-Macros | |
| #define | UEL_DECLARE_OBJPOOL_BUFFERS(type, size_log2n, id) |
| Declares the necessary buffers to back an object pool, so the programmer doesn't have to reason much about it. More... | |
| #define | UEL_OBJPOOL_BUFFERS(id) (uint8_t *)&id##_pool_buffer, id##_pool_queue_buffer |
| Refers to a previously declared buffer set. More... | |
| #define | UEL_OBJPOOL_BUFFERS_IN(id, obj) (uint8_t *)&obj.id##_pool_buffer, obj.id##_pool_queue_buffer |
| Refers to a previously declared buffer set. More... | |
| #define | UEL_OBJPOOL_BUFFERS_AT(id, obj) (uint8_t *)&obj->id##_pool_buffer, obj->id##_pool_queue_buffer |
| Refers to a previously declared buffer set. More... | |
-Functions | |
| void | uel_objpool_init (uel_objpool_t *pool, size_t size_log2n, size_t item_size, uint8_t *buffer, void **queue_buffer) |
| Initialises an object pool. More... | |
| void * | uel_objpool_acquire (uel_objpool_t *pool) |
| Acquires an object from the pool. More... | |
| bool | uel_objpool_release (uel_objpool_t *pool, void *element) |
| Releases an object to the pool. More... | |
| bool | uel_objpool_is_empty (uel_objpool_t *pool) |
| Checks if a pool is depleted. More... | |
Defines object pools, arrays of pre-allocated objects for dynamic use.
-| #define UEL_DECLARE_OBJPOOL_BUFFERS | -( | -- | type, | -
| - | - | - | size_log2n, | -
| - | - | - | id | -
| - | ) | -- |
Declares the necessary buffers to back an object pool, so the programmer doesn't have to reason much about it.
-Use this macro as a shortcut to create the required buffers for an object pool. This will declare two buffers in the calling scope.
-| type | The type of the objects the pool will contain |
| size_log2n | The number of elements the pool will contain in log2 form |
| id | A valid identifier for the pools. |
| #define UEL_OBJPOOL_BUFFERS | -( | -- | id | ) | -(uint8_t *)&id##_pool_buffer, id##_pool_queue_buffer | -
Refers to a previously declared buffer set.
-This is a convenience macro to supply the buffers generated by UEL_DECLARE_OBJPOOL_BUFFERS to the uel_objpool_init function.
| id | The identifier used to declare the pool buffers |
| #define UEL_OBJPOOL_BUFFERS_AT | -( | -- | id, | -
| - | - | - | obj | -
| - | ) | -(uint8_t *)&obj->id##_pool_buffer, obj->id##_pool_queue_buffer | -
Refers to a previously declared buffer set.
-This is a convenience macro to supply the buffers generated by UEL_DECLARE_OBJPOOL_BUFFERS to the uel_objpool_init function. Use this if the buffers were defined inside an object whose address is accessible in the current scope
| id | The identifier used to declare the pool buffers |
| obj | The address of the object storing the pool buffers |
| #define UEL_OBJPOOL_BUFFERS_IN | -( | -- | id, | -
| - | - | - | obj | -
| - | ) | -(uint8_t *)&obj.id##_pool_buffer, obj.id##_pool_queue_buffer | -
Refers to a previously declared buffer set.
-This is a convenience macro to supply the buffers generated by UEL_DECLARE_OBJPOOL_BUFFERS to the uel_objpool_init function. Use this if the buffers were defined inside a local object, accessible in the current scope.
| id | The identifier used to declare the pool buffers |
| obj | The object storing the pool buffers |
| void* uel_objpool_acquire | -( | -uel_objpool_t * | -pool | ) | -- |
Acquires an object from the pool.
-| pool | The pool from where to acquire the object |
| void uel_objpool_init | -( | -uel_objpool_t * | -pool, | -
| - | - | size_t | -size_log2n, | -
| - | - | size_t | -item_size, | -
| - | - | uint8_t * | -buffer, | -
| - | - | void ** | -queue_buffer | -
| - | ) | -- |
Initialises an object pool.
-| pool | The pool to be initialised |
| size_log2n | The number of objects in the pool in its log2 form |
| item_size | The size of each object in the pool. If special alignment is required, it must be included in this value. |
| buffer | The buffer that contains each object in the pool. Must be 2**size_log2n * item_size long. |
| queue_buffer | A void pointer array that will be used as the buffer to the object pointer queue. Must be 2**size_log2n long. |
| bool uel_objpool_is_empty | -( | -uel_objpool_t * | -pool | ) | -- |
Checks if a pool is depleted.
-| pool | The pool to be verified |
| bool uel_objpool_release | -( | -uel_objpool_t * | -pool, | -
| - | - | void * | -element | -
| - | ) | -- |
Releases an object to the pool.
-| pool | The pool where the object will be released to |
| element | The element to be returned to the pool |
- 1.8.17
-
-
-
diff --git a/docs/html/object-pool_8h__dep__incl.map b/docs/html/object-pool_8h__dep__incl.map
deleted file mode 100644
index 71ba2ac..0000000
--- a/docs/html/object-pool_8h__dep__incl.map
+++ /dev/null
@@ -1,10 +0,0 @@
-
diff --git a/docs/html/object-pool_8h__dep__incl.md5 b/docs/html/object-pool_8h__dep__incl.md5
deleted file mode 100644
index 9aad823..0000000
--- a/docs/html/object-pool_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-50ceb4f6751a9a62ae0e924b409f0aac
\ No newline at end of file
diff --git a/docs/html/object-pool_8h__dep__incl.png b/docs/html/object-pool_8h__dep__incl.png
deleted file mode 100644
index ac9eb2a..0000000
Binary files a/docs/html/object-pool_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/object-pool_8h__incl.map b/docs/html/object-pool_8h__incl.map
deleted file mode 100644
index ab978d4..0000000
--- a/docs/html/object-pool_8h__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/object-pool_8h__incl.md5 b/docs/html/object-pool_8h__incl.md5
deleted file mode 100644
index d305a86..0000000
--- a/docs/html/object-pool_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-03d2009b46606b7f38a9e77f8bcb4b7e
\ No newline at end of file
diff --git a/docs/html/object-pool_8h__incl.png b/docs/html/object-pool_8h__incl.png
deleted file mode 100644
index dee660e..0000000
Binary files a/docs/html/object-pool_8h__incl.png and /dev/null differ
diff --git a/docs/html/object-pool_8h_source.html b/docs/html/object-pool_8h_source.html
deleted file mode 100644
index eacec63..0000000
--- a/docs/html/object-pool_8h_source.html
+++ /dev/null
@@ -1,132 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/open.png b/docs/html/open.png
deleted file mode 100644
index 30f75c7..0000000
Binary files a/docs/html/open.png and /dev/null differ
diff --git a/docs/html/pipeline_8h.html b/docs/html/pipeline_8h.html
deleted file mode 100644
index 1480ca6..0000000
--- a/docs/html/pipeline_8h.html
+++ /dev/null
@@ -1,263 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines pipelines, structures to hold many closures and functions to invoke them sequentially, composing their functionality. -More...
-#include "uevloop/utils/closure.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_pipeline_t |
| A pipeline is an ordered closure list to be run in sequence. More... | |
-Macros | |
| #define | UEL_PIPELINE_DECLARE(id, ...) |
| Helper macro to create a pipeline and its required data structures. More... | |
-Functions | |
| void | uel_pipeline_init (uel_pipeline_t *pipeline, uel_closure_t *closures, size_t count) |
| Initialises a new pipeline. More... | |
| void * | uel_pipeline_apply (uel_pipeline_t *pipeline, void *params) |
| Applies a pipeline to some input. More... | |
Defines pipelines, structures to hold many closures and functions to invoke them sequentially, composing their functionality.
-| #define UEL_PIPELINE_DECLARE | -( | -- | id, | -
| - | - | - | ... | -
| - | ) | -- |
Helper macro to create a pipeline and its required data structures.
-This macro, based on the input identifier, declares:
| id | The identifier on which to base declared variables' names. |
| ... | The closures to be pipelined. |
| void* uel_pipeline_apply | -( | -uel_pipeline_t * | -pipeline, | -
| - | - | void * | -params | -
| - | ) | -- |
Applies a pipeline to some input.
-This function takes some input and passes it to the first closure in the pipeline. The value returned from this first closure will be passed to the second one and so on.
-| pipeline | The pipeline to be applied |
| params | The initial parameters that will be passed to the first closure |
| void uel_pipeline_init | -( | -uel_pipeline_t * | -pipeline, | -
| - | - | uel_closure_t * | -closures, | -
| - | - | size_t | -count | -
| - | ) | -- |
Initialises a new pipeline.
-| pipeline | The pipeline to be initialised |
| closures | The closures that should be run in sequence, in an array. |
| count | The number of closures to be piped. |
- 1.8.17
-
-
-
diff --git a/docs/html/pipeline_8h__dep__incl.map b/docs/html/pipeline_8h__dep__incl.map
deleted file mode 100644
index 2332f3e..0000000
--- a/docs/html/pipeline_8h__dep__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/pipeline_8h__dep__incl.md5 b/docs/html/pipeline_8h__dep__incl.md5
deleted file mode 100644
index 5c827ec..0000000
--- a/docs/html/pipeline_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-1e9ecc8ead6b0a9d7bf07d131e1bc03b
\ No newline at end of file
diff --git a/docs/html/pipeline_8h__dep__incl.png b/docs/html/pipeline_8h__dep__incl.png
deleted file mode 100644
index 9257610..0000000
Binary files a/docs/html/pipeline_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/pipeline_8h__incl.map b/docs/html/pipeline_8h__incl.map
deleted file mode 100644
index f234291..0000000
--- a/docs/html/pipeline_8h__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/pipeline_8h__incl.md5 b/docs/html/pipeline_8h__incl.md5
deleted file mode 100644
index 7e24513..0000000
--- a/docs/html/pipeline_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-9d213d876bc874a9add1787a88dde080
\ No newline at end of file
diff --git a/docs/html/pipeline_8h__incl.png b/docs/html/pipeline_8h__incl.png
deleted file mode 100644
index f2dde27..0000000
Binary files a/docs/html/pipeline_8h__incl.png and /dev/null differ
diff --git a/docs/html/pipeline_8h_source.html b/docs/html/pipeline_8h_source.html
deleted file mode 100644
index 13598c7..0000000
--- a/docs/html/pipeline_8h_source.html
+++ /dev/null
@@ -1,112 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/promise_8h.html b/docs/html/promise_8h.html
deleted file mode 100644
index d1c41b8..0000000
--- a/docs/html/promise_8h.html
+++ /dev/null
@@ -1,675 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains definitions for promise stores, promises and functions to manipulate them. -More...
-#include "uevloop/config.h"#include "uevloop/utils/closure.h"#include "uevloop/utils/object-pool.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_promise_segment_t |
| Defines a single synchronous operation to be invoked when the promise is either resolved or rejected. More... | |
| struct | uel_promise_t |
| A promise is association of an asynchronous operation to the possible execution paths that follow its resolution. It is also a holder for the value it was settled with. More... | |
| struct | uel_promise_store_t |
| An issuer of promises. Contains references to pools for promises and segments. More... | |
-Typedefs | |
| -typedef enum uel_promise_state | uel_promise_state_t |
Alias to the uel_promise_state enum. | |
-Enumerations | |
| enum | uel_promise_state { UEL_PROMISE_PENDING, -UEL_PROMISE_RESOLVED, -UEL_PROMISE_REJECTED - } |
| Defines the possible states for a prommise. More... | |
-Functions | |
| uel_promise_store_t | uel_promise_store_create (uel_objpool_t *promise_pool, uel_objpool_t *segment_pool) |
| Creates a new promise store from the promise and segment pools. More... | |
| uel_promise_t * | uel_promise_create (uel_promise_store_t *store, uel_closure_t closure) |
| Acquires a new promise from the supplied store and binds it to the asynchronous operation started by the supplied closure. The closure is invoked immediately. More... | |
| void | uel_promise_destroy (uel_promise_t *promise) |
| Destroys a promise and all of its segments. Settling this promise afterwards yields undefined behaviour. More... | |
| void | uel_promise_then (uel_promise_t *promise, uel_closure_t resolve) |
| Adds a new synchronous segment to the promise. It will be invoked upon promise resolution. In case of rejection, this segment will be ignored. More... | |
| void | uel_promise_catch (uel_promise_t *promise, uel_closure_t reject) |
| Adds a new synchronous segment to the promise. It will be invoked upon promise rejection. In case of resolution, this segment will be ignored. More... | |
| void | uel_promise_always (uel_promise_t *promise, uel_closure_t always) |
| Adds a new synchronous segment to the promise. The same closure will be invoked on promise settling regardless of the settled state. More... | |
| void | uel_promise_after (uel_promise_t *promise, uel_closure_t resolve, uel_closure_t reject) |
| Adds a new synchronous segment to the promise. Either of its closures will be invoked, depending on the settled state of the promise. More... | |
| void | uel_promise_resolve (uel_promise_t *promise, void *value) |
Settles a promise as resolved and, synchronously, invokes the resolve closures of each segment in the order they were registered. More... | |
| void | uel_promise_reject (uel_promise_t *promise, void *value) |
Settles a promise as rejected and, synchronously, invokes the reject closures of each segment in the order they were registered. More... | |
| void | uel_promise_resettle (uel_promise_t *promise, uel_promise_state_t state, void *value) |
Resettles a promise as the supplied state. Unlike uel_promise_resolve() and uel_promise_reject(), does not invoke the synchronous segments. More... | |
| uel_closure_t | uel_promise_resolver (uel_promise_t *promise) |
| Creates a closure bound to a promise. When the closure is invoked with some parameter, the promise is resolved with this parameter as value. More... | |
| uel_closure_t | uel_promise_rejecter (uel_promise_t *promise) |
| Creates a closure bound to a promise. When the closure is invoked with some parameter, the promise is rejected with this parameter as error. More... | |
| uel_closure_t | uel_promise_destroyer (uel_promise_t *promise) |
| Creates a closure bound to a promise. When the closure is invoked, the promise is destroyed. Any parameters passed to the closure are ignored. More... | |
Contains definitions for promise stores, promises and functions to manipulate them.
-Promises are structures that associate asynchronous operations to synchronous processing of the values produces by them, allowing async data pipelines to be built.
-| enum uel_promise_state | -
| void uel_promise_after | -( | -uel_promise_t * | -promise, | -
| - | - | uel_closure_t | -resolve, | -
| - | - | uel_closure_t | -reject | -
| - | ) | -- |
Adds a new synchronous segment to the promise. Either of its closures will be invoked, depending on the settled state of the promise.
-| promise | The promise to attach the segment to |
| resolve | The closure to be invoked when the promise is resolved |
| reject | The closure to be invoked when the promise is rejected |
| void uel_promise_always | -( | -uel_promise_t * | -promise, | -
| - | - | uel_closure_t | -always | -
| - | ) | -- |
Adds a new synchronous segment to the promise. The same closure will be invoked on promise settling regardless of the settled state.
-| promise | The promise to attach the segment to |
| always | The closure to be invoked when the promise is settled |
| void uel_promise_catch | -( | -uel_promise_t * | -promise, | -
| - | - | uel_closure_t | -reject | -
| - | ) | -- |
Adds a new synchronous segment to the promise. It will be invoked upon promise rejection. In case of resolution, this segment will be ignored.
-| promise | The promise to attach the segment to |
| reject | The closure to be invoked when the promise is rejected |
| uel_promise_t* uel_promise_create | -( | -uel_promise_store_t * | -store, | -
| - | - | uel_closure_t | -closure | -
| - | ) | -- |
Acquires a new promise from the supplied store and binds it to the asynchronous operation started by the supplied closure. The closure is invoked immediately.
-| store | The store from where to acquire promises and segments |
| closure | The closure that initiates the asynchronous operation |
| void uel_promise_destroy | -( | -uel_promise_t * | -promise | ) | -- |
Destroys a promise and all of its segments. Settling this promise afterwards yields undefined behaviour.
-| promise | The promise to be destroyed |
| uel_closure_t uel_promise_destroyer | -( | -uel_promise_t * | -promise | ) | -- |
Creates a closure bound to a promise. When the closure is invoked, the promise is destroyed. Any parameters passed to the closure are ignored.
-| promise | The promise to be destroyed |
| void uel_promise_reject | -( | -uel_promise_t * | -promise, | -
| - | - | void * | -value | -
| - | ) | -- |
Settles a promise as rejected and, synchronously, invokes the reject closures of each segment in the order they were registered.
If a segment returns a non-NULL pointer, it is cast to a promise pointer and the original promise awaits until the returned promise is settled.
-| promise | The promise to be rejected |
| value | The value to reject the promise with |
| uel_closure_t uel_promise_rejecter | -( | -uel_promise_t * | -promise | ) | -- |
Creates a closure bound to a promise. When the closure is invoked with some parameter, the promise is rejected with this parameter as error.
-| promise | The promise to be rejected |
| void uel_promise_resettle | -( | -uel_promise_t * | -promise, | -
| - | - | uel_promise_state_t | -state, | -
| - | - | void * | -value | -
| - | ) | -- |
Resettles a promise as the supplied state. Unlike uel_promise_resolve() and uel_promise_reject(), does not invoke the synchronous segments.
This function should be used to switch execution paths during synchronous processing of segments as to signal that an error was raised or rescued by a particular segment. If the promise is settled as pending, the synchronous processing phase is interrupted.
-| promise | The promise to be resettled |
| state | The new promise state |
| value | The new promise value |
| void uel_promise_resolve | -( | -uel_promise_t * | -promise, | -
| - | - | void * | -value | -
| - | ) | -- |
Settles a promise as resolved and, synchronously, invokes the resolve closures of each segment in the order they were registered.
If a segment returns a non-NULL pointer, it is cast to a promise pointer and the original promise awaits until the returned promise is settled.
-| promise | The promise to be resolved |
| value | The value to resolve the promise with |
| uel_closure_t uel_promise_resolver | -( | -uel_promise_t * | -promise | ) | -- |
Creates a closure bound to a promise. When the closure is invoked with some parameter, the promise is resolved with this parameter as value.
-| promise | The promise to be resolved |
| uel_promise_store_t uel_promise_store_create | -( | -uel_objpool_t * | -promise_pool, | -
| - | - | uel_objpool_t * | -segment_pool | -
| - | ) | -- |
Creates a new promise store from the promise and segment pools.
-| promise_pool | The uel_objpool_t that holds promises |
| segment_pool | The uel_objpool_t that holds segments |
| void uel_promise_then | -( | -uel_promise_t * | -promise, | -
| - | - | uel_closure_t | -resolve | -
| - | ) | -- |
Adds a new synchronous segment to the promise. It will be invoked upon promise resolution. In case of rejection, this segment will be ignored.
-| promise | The promise to attach the segment to |
| resolve | The closure to be invoked when the promise is resolved |
- 1.8.17
-
-
-
diff --git a/docs/html/promise_8h__dep__incl.map b/docs/html/promise_8h__dep__incl.map
deleted file mode 100644
index 87670cc..0000000
--- a/docs/html/promise_8h__dep__incl.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/promise_8h__dep__incl.md5 b/docs/html/promise_8h__dep__incl.md5
deleted file mode 100644
index dc5ebd4..0000000
--- a/docs/html/promise_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-83c72b3ad3daea9d190447292bb2c34d
\ No newline at end of file
diff --git a/docs/html/promise_8h__dep__incl.png b/docs/html/promise_8h__dep__incl.png
deleted file mode 100644
index 6ea8a11..0000000
Binary files a/docs/html/promise_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/promise_8h__incl.map b/docs/html/promise_8h__incl.map
deleted file mode 100644
index 8c09182..0000000
--- a/docs/html/promise_8h__incl.map
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/docs/html/promise_8h__incl.md5 b/docs/html/promise_8h__incl.md5
deleted file mode 100644
index 945a4a0..0000000
--- a/docs/html/promise_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-834f68ead18af34286a97a93509f6657
\ No newline at end of file
diff --git a/docs/html/promise_8h__incl.png b/docs/html/promise_8h__incl.png
deleted file mode 100644
index d6c0c9f..0000000
Binary files a/docs/html/promise_8h__incl.png and /dev/null differ
diff --git a/docs/html/promise_8h_source.html b/docs/html/promise_8h_source.html
deleted file mode 100644
index 2e7b710..0000000
--- a/docs/html/promise_8h_source.html
+++ /dev/null
@@ -1,202 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/scheduler_8h.html b/docs/html/scheduler_8h.html
deleted file mode 100644
index b9273ee..0000000
--- a/docs/html/scheduler_8h.html
+++ /dev/null
@@ -1,365 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Module responsible for keeping track of time and tasks to be run in the future. -More...
-#include "uevloop/system/containers/system-pools.h"#include "uevloop/system/containers/system-queues.h"#include "uevloop/utils/linked-list.h"#include "uevloop/utils/closure.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_scheduer_t |
| The scheduler object. More... | |
-Functions | |
| void | uel_sch_init (uel_scheduer_t *scheduler, uel_syspools_t *pools, uel_sysqueues_t *queues) |
| Initialises a scheduler object. More... | |
| uel_event_t * | uel_sch_run_later (uel_scheduer_t *scheduler, uint16_t timeout_in_ms, uel_closure_t closure, void *value) |
| Enqueues a closure for later execution. More... | |
| uel_event_t * | uel_sch_run_at_intervals (uel_scheduer_t *scheduler, uint16_t interval_in_ms, bool immediate, uel_closure_t closure, void *value) |
| Enqueues a closure for execution at intervals. More... | |
| void | uel_sch_manage_timers (uel_scheduer_t *scheduler) |
| Enqueue timers that are due to be processed in the event queue. More... | |
| void | uel_sch_update_timer (uel_scheduer_t *scheduler, uint32_t timer) |
| Updates the internal time counter. More... | |
Module responsible for keeping track of time and tasks to be run in the future.
-| void uel_sch_init | -( | -uel_scheduer_t * | -scheduler, | -
| - | - | uel_syspools_t * | -pools, | -
| - | - | uel_sysqueues_t * | -queues | -
| - | ) | -- |
Initialises a scheduler object.
-| scheduler | The uel_scheduer_t instance to be initialised |
| pools | The system's internal pools |
| queues | The system's internal queues |
| void uel_sch_manage_timers | -( | -uel_scheduer_t * | -scheduler | ) | -- |
Enqueue timers that are due to be processed in the event queue.
-Checks, based on the current time counter, what timers should be enqueued for execution. Afterwards, enqueue them.
-| scheduler | The uel_scheduer_t to manage |
| uel_event_t* uel_sch_run_at_intervals | -( | -uel_scheduer_t * | -scheduler, | -
| - | - | uint16_t | -interval_in_ms, | -
| - | - | bool | -immediate, | -
| - | - | uel_closure_t | -closure, | -
| - | - | void * | -value | -
| - | ) | -- |
Enqueues a closure for execution at intervals.
-| scheduler | The uel_scheduer_t into which the event will be registered |
| interval_in_ms | The delay in milliseconds two executions of the closure |
| immediate | If this flag is set, the the event will be created with a due time to the current time. |
| closure | The closure to be invoked when the due time is reached |
| value | The value to invoked the closure with |
| uel_event_t* uel_sch_run_later | -( | -uel_scheduer_t * | -scheduler, | -
| - | - | uint16_t | -timeout_in_ms, | -
| - | - | uel_closure_t | -closure, | -
| - | - | void * | -value | -
| - | ) | -- |
Enqueues a closure for later execution.
-| scheduler | The uel_scheduer_t into which the event will be registered |
| timeout_in_ms | The delay in milliseconds until the closure is run |
| closure | The closure to be invoked when the due time is reached |
| value | The value to invoked the closure with |
| void uel_sch_update_timer | -( | -uel_scheduer_t * | -scheduler, | -
| - | - | uint32_t | -timer | -
| - | ) | -- |
Updates the internal time counter.
-| scheduler | The scheduler whose time coounter should be updated |
| timer | The new counter value to be acknowledged. |
- 1.8.17
-
-
-
diff --git a/docs/html/scheduler_8h__dep__incl.map b/docs/html/scheduler_8h__dep__incl.map
deleted file mode 100644
index d475202..0000000
--- a/docs/html/scheduler_8h__dep__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/scheduler_8h__dep__incl.md5 b/docs/html/scheduler_8h__dep__incl.md5
deleted file mode 100644
index f2c900e..0000000
--- a/docs/html/scheduler_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-d0d34a02aa097dc13ef389450e75f2a6
\ No newline at end of file
diff --git a/docs/html/scheduler_8h__dep__incl.png b/docs/html/scheduler_8h__dep__incl.png
deleted file mode 100644
index 3011801..0000000
Binary files a/docs/html/scheduler_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/scheduler_8h__incl.map b/docs/html/scheduler_8h__incl.map
deleted file mode 100644
index bcb2ed7..0000000
--- a/docs/html/scheduler_8h__incl.map
+++ /dev/null
@@ -1,11 +0,0 @@
-
diff --git a/docs/html/scheduler_8h__incl.md5 b/docs/html/scheduler_8h__incl.md5
deleted file mode 100644
index 304d901..0000000
--- a/docs/html/scheduler_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-4364fb280af1d2730ffa9ac02cb82df9
\ No newline at end of file
diff --git a/docs/html/scheduler_8h__incl.png b/docs/html/scheduler_8h__incl.png
deleted file mode 100644
index bfc66b7..0000000
Binary files a/docs/html/scheduler_8h__incl.png and /dev/null differ
diff --git a/docs/html/scheduler_8h_source.html b/docs/html/scheduler_8h_source.html
deleted file mode 100644
index 7af9a80..0000000
--- a/docs/html/scheduler_8h_source.html
+++ /dev/null
@@ -1,146 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/search/all_0.html b/docs/html/search/all_0.html
deleted file mode 100644
index 26dd244..0000000
--- a/docs/html/search/all_0.html
+++ /dev/null
@@ -1,30 +0,0 @@
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines signals and relays, structures used to communicate asynchronously between distant parts of the application. -More...
-#include "uevloop/utils/linked-list.h"#include "uevloop/utils/closure.h"#include "uevloop/utils/promise.h"#include "uevloop/system/containers/system-pools.h"#include "uevloop/system/containers/system-queues.h"#include "uevloop/system/event.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_signal_relay_t |
| Contains a signal vector and operates on in. More... | |
-Typedefs | |
| typedef uintptr_t | uel_signal_t |
| -typedef struct uel_event_listener * | uel_signal_listener_t |
| Defines a reference type suitable to manipulate the actual listener event's context. | |
-Functions | |
| void | uel_signal_relay_init (uel_signal_relay_t *relay, uel_syspools_t *pools, uel_sysqueues_t *queues, uel_llist_t *buffer, uintptr_t width) |
| Initialises a signal relay. More... | |
| uel_signal_listener_t | uel_signal_listen (uel_signal_t signal, uel_signal_relay_t *relay, uel_closure_t *closure) |
| Attaches a listener closure to some signal at a particular relay. More... | |
| uel_signal_listener_t | uel_signal_listen_once (uel_signal_t signal, uel_signal_relay_t *relay, uel_closure_t *closure) |
| Attaches a listener closure to some signal at a particular relay. The listener closure will be invoked only once. More... | |
| void | uel_signal_unlisten (uel_signal_listener_t listener) |
| Marks a signal listener as expired. When its corresponding signal is emitted, this listener's closure will not be invoked and the listener will be destroyed. More... | |
| void | uel_signal_emit (uel_signal_t signal, uel_signal_relay_t *relay, void *params) |
| Emits a signal at the supplied relay. Any closure listening to this signal will be asynchronously invoked. More... | |
| uel_signal_listener_t | uel_signal_resolve_promise (uel_signal_t signal, uel_signal_relay_t *relay, uel_promise_t *promise) |
| Attaches a non-repeating listener that resolves the provided promise upon emission. More... | |
| uel_signal_listener_t | uel_signal_reject_promise (uel_signal_t signal, uel_signal_relay_t *relay, uel_promise_t *promise) |
| Attaches a non-repeating listener that rejects the provided promise upon emission. More... | |
Defines signals and relays, structures used to communicate asynchronously between distant parts of the application.
-| uel_signal_t | -
Any signal is defined as an unsigned integer type. This means that any signal type is only valid within the scope defined by the relay designed to respond to said signal.
- -| void uel_signal_emit | -( | -uel_signal_t | -signal, | -
| - | - | uel_signal_relay_t * | -relay, | -
| - | - | void * | -params | -
| - | ) | -- |
Emits a signal at the supplied relay. Any closure listening to this signal will be asynchronously invoked.
-| signal | The signal to be emitted |
| relay | The relay where the signal is registered |
| params | The parameters supplied to the listener's closure when it is invoked. |
| uel_signal_listener_t uel_signal_listen | -( | -uel_signal_t | -signal, | -
| - | - | uel_signal_relay_t * | -relay, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Attaches a listener closure to some signal at a particular relay.
-| signal | The signal to be listened for |
| relay | The relay where the listener will be registered |
| closure | The closure to be invoked when the signal is emitted. The closure will be invoked with whatever parameters are supplied during emission. |
| uel_signal_listener_t uel_signal_listen_once | -( | -uel_signal_t | -signal, | -
| - | - | uel_signal_relay_t * | -relay, | -
| - | - | uel_closure_t * | -closure | -
| - | ) | -- |
Attaches a listener closure to some signal at a particular relay. The listener closure will be invoked only once.
-| signal | The signal to be listened for |
| relay | The relay where the listener will be registered |
| closure | The closure to be invoked when the signal is emitted. The closure will be invoked with whatever parameters are supplied during emission. |
| uel_signal_listener_t uel_signal_reject_promise | -( | -uel_signal_t | -signal, | -
| - | - | uel_signal_relay_t * | -relay, | -
| - | - | uel_promise_t * | -promise | -
| - | ) | -- |
Attaches a non-repeating listener that rejects the provided promise upon emission.
-| signal | The signal to be listened for |
| relay | The relay where the signal is registered |
| promise | The promise to be rejected upon signal emission |
| void uel_signal_relay_init | -( | -uel_signal_relay_t * | -relay, | -
| - | - | uel_syspools_t * | -pools, | -
| - | - | uel_sysqueues_t * | -queues, | -
| - | - | uel_llist_t * | -buffer, | -
| - | - | uintptr_t | -width | -
| - | ) | -- |
Initialises a signal relay.
-| relay | The signal relay object to be initialised |
| pools | The system's internal pools |
| queues | The system's internal queues |
| buffer | The buffer that will be used to store listeners registered at this relay. Must be the number of signals bound to this relay wide. |
| width | The number of signals bound to this relay. |
| uel_signal_listener_t uel_signal_resolve_promise | -( | -uel_signal_t | -signal, | -
| - | - | uel_signal_relay_t * | -relay, | -
| - | - | uel_promise_t * | -promise | -
| - | ) | -- |
Attaches a non-repeating listener that resolves the provided promise upon emission.
-| signal | The signal to be listened for |
| relay | The relay where the signal is registered |
| promise | The promise to be resolved upon signal emission |
| void uel_signal_unlisten | -( | -uel_signal_listener_t | -listener | ) | -- |
Marks a signal listener as expired. When its corresponding signal is emitted, this listener's closure will not be invoked and the listener will be destroyed.
-| listener | The listener that identifies the listen operation to be undone |
- 1.8.17
-
-
-
diff --git a/docs/html/signal_8h__dep__incl.map b/docs/html/signal_8h__dep__incl.map
deleted file mode 100644
index 7d9123d..0000000
--- a/docs/html/signal_8h__dep__incl.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/signal_8h__dep__incl.md5 b/docs/html/signal_8h__dep__incl.md5
deleted file mode 100644
index 7b22c30..0000000
--- a/docs/html/signal_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-55a842d5522776eade431677134833be
\ No newline at end of file
diff --git a/docs/html/signal_8h__dep__incl.png b/docs/html/signal_8h__dep__incl.png
deleted file mode 100644
index 88e69b5..0000000
Binary files a/docs/html/signal_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/signal_8h__incl.map b/docs/html/signal_8h__incl.map
deleted file mode 100644
index 2becd3c..0000000
--- a/docs/html/signal_8h__incl.map
+++ /dev/null
@@ -1,12 +0,0 @@
-
diff --git a/docs/html/signal_8h__incl.md5 b/docs/html/signal_8h__incl.md5
deleted file mode 100644
index 8442ba3..0000000
--- a/docs/html/signal_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-89f0d3611c0aae40ce6e7e8ecdf592ce
\ No newline at end of file
diff --git a/docs/html/signal_8h__incl.png b/docs/html/signal_8h__incl.png
deleted file mode 100644
index 96a73fd..0000000
Binary files a/docs/html/signal_8h__incl.png and /dev/null differ
diff --git a/docs/html/signal_8h_source.html b/docs/html/signal_8h_source.html
deleted file mode 100644
index da39eda..0000000
--- a/docs/html/signal_8h_source.html
+++ /dev/null
@@ -1,161 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/splitbar.png b/docs/html/splitbar.png
deleted file mode 100644
index fe895f2..0000000
Binary files a/docs/html/splitbar.png and /dev/null differ
diff --git a/docs/html/structevent.html b/docs/html/structevent.html
deleted file mode 100644
index 4e54d84..0000000
--- a/docs/html/structevent.html
+++ /dev/null
@@ -1,149 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Events are special messages passed around the core. They represent tasks to be run at some point by the system. - More...
-
-Data Structures | |
| union | uel_event_detail |
-Data Fields | |
| -uel_event_type_t | type |
The type of the event, as defined by uel_event_type_t | |
| -uel_closure_t | closure |
| The closure to be invoked a.k.a. the action to be run. | |
| -void * | value |
| The value the closure should be invoked with. | |
| -bool | repeating |
| Marks whether the event should be discarded after processing. | |
| -union event::uel_event_detail | detail |
| Represents speciffic detail on a event depending on its type. | |
Events are special messages passed around the core. They represent tasks to be run at some point by the system.
-Events are bound to information on how and when they should be invoked. There are five types of events:
-UEL_CLOSURE_EVENT: lifeless wrappers to closures.UEL_TIMER_EVENT: contains scheduling information associated with some closureUEL_SIGNAL_EVENT: contains information on the emission of a signalUEL_SIGNAL_LISTENER_EVENT: represent a single listening operationUEL_OBSERVER_EVENT: represents a variable being observer by the event loopClosure and timer events can be recurring, in which case they won't be discarded after processing by the event loop.
-Signal events are always discarded by the event loop. Signal listeners are never meant to be sent there. In their case, the repeating flag determines whether the signal should be able to fire multiple times or just once.
- 1.8.17
-
-
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener.html b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener.html
deleted file mode 100644
index 7f149f4..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener.html
+++ /dev/null
@@ -1,124 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains the context of a particular signal listener. - More...
- -#include <event.h>
-Data Fields | |
| bool | unlistened |
Contains the context of a particular signal listener.
-| bool uel_event_t::uel_event_detail::uel_event_listener::unlistened | -
When this flag is set, the event_loop will not run this event's closure. Additionally, the event will be destroyed.
- 1.8.17
-
-
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.map b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.map
deleted file mode 100644
index d4cfbc7..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.md5 b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.md5
deleted file mode 100644
index 7b58471..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-07359ca3e14dff525078b4cc6a612a6a
\ No newline at end of file
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.png b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.png
deleted file mode 100644
index 3abd1a1..0000000
Binary files a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__listener__coll__graph.png and /dev/null differ
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer.html b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer.html
deleted file mode 100644
index 4cef98e..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer.html
+++ /dev/null
@@ -1,133 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains the reference to an observer variable. - More...
- -#include <event.h>
-Data Fields | |
| -volatile uintptr_t * | condition_var |
| The address of a volatile value to observe. | |
| uintptr_t | last_value |
| -bool | cancelled |
| Whether this observer has been cancelled and is awaiting for destruction. | |
Contains the reference to an observer variable.
-| uintptr_t uel_event_t::uel_event_detail::uel_event_observer::last_value | -
The last value read
- -
- 1.8.17
-
-
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.map b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.map
deleted file mode 100644
index e79a83e..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.md5 b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.md5
deleted file mode 100644
index 730540c..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-7a346f8375a1adc8d6e8becd9eac5864
\ No newline at end of file
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.png b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.png
deleted file mode 100644
index 112f713..0000000
Binary files a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__observer__coll__graph.png and /dev/null differ
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal.html b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal.html
deleted file mode 100644
index a07972d..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal.html
+++ /dev/null
@@ -1,115 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains information related to an emitted signal.
- More...
#include <event.h>
-Data Fields | |
| -uintptr_t | value |
| The integer value that identifies this signal. | |
| -uel_llist_t * | listeners |
| Reference to the signal listeners. | |
Contains information related to an emitted signal.
- 1.8.17
-
-
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.map b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.map
deleted file mode 100644
index eaa5044..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.md5 b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.md5
deleted file mode 100644
index f6bdb61..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-8130dcbe5dc62eb4e70365054663250f
\ No newline at end of file
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.png b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.png
deleted file mode 100644
index 091ef27..0000000
Binary files a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__signal__coll__graph.png and /dev/null differ
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer.html b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer.html
deleted file mode 100644
index 11c7eca..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer.html
+++ /dev/null
@@ -1,120 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains information suitable for scheduling an event at the scheduler. - More...
- -#include <event.h>
-Data Fields | |
| -uint32_t | due_time |
| The value the system timer must be at when this event's closure should be invoked. This is a best effort value. | |
| -uint16_t | timeout |
| Holds the interval between two executions of the timer. | |
| -uel_event_timer_status_t | status |
| Current timer status. | |
Contains information suitable for scheduling an event at the scheduler.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.map b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.map
deleted file mode 100644
index 540c440..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.map
+++ /dev/null
@@ -1,6 +0,0 @@
-
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.md5 b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.md5
deleted file mode 100644
index 3831385..0000000
--- a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-503d112eba55590e204abd1b97cc4bbf
\ No newline at end of file
diff --git a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.png b/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.png
deleted file mode 100644
index 3fa8a33..0000000
Binary files a/docs/html/structevent_1_1uel__event__detail_1_1uel__event__timer__coll__graph.png and /dev/null differ
diff --git a/docs/html/structevent__coll__graph.map b/docs/html/structevent__coll__graph.map
deleted file mode 100644
index 5e7fd2f..0000000
--- a/docs/html/structevent__coll__graph.map
+++ /dev/null
@@ -1,17 +0,0 @@
-
diff --git a/docs/html/structevent__coll__graph.md5 b/docs/html/structevent__coll__graph.md5
deleted file mode 100644
index 35101c9..0000000
--- a/docs/html/structevent__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-d07f81fdb67acb725b580c5cae8dde1d
\ No newline at end of file
diff --git a/docs/html/structevent__coll__graph.png b/docs/html/structevent__coll__graph.png
deleted file mode 100644
index cec2d8d..0000000
Binary files a/docs/html/structevent__coll__graph.png and /dev/null differ
diff --git a/docs/html/structsyspools.html b/docs/html/structsyspools.html
deleted file mode 100644
index f454661..0000000
--- a/docs/html/structsyspools.html
+++ /dev/null
@@ -1,128 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A container for the system pools. - More...
-
-Data Fields | |
| -uel_event_t | event_pool_buffer [UEL_SYSPOOLS_EVENT_POOL_SIZE] |
| The buffer used to store events in the event pool. | |
| -void * | event_pool_queue_buffer [UEL_SYSPOOLS_EVENT_POOL_SIZE] |
| The buffer used to store event pointers in the event pool queue. | |
| -uel_objpool_t | event_pool |
| The event pool object. Contains all the events used by the core. | |
| -uel_llist_node_t | llist_node_pool_buffer [UEL_SYSPOOLS_LLIST_NODE_POOL_SIZE] |
| The buffer used to store llist nodes in the llist node pool. | |
| -void * | llist_node_pool_queue_buffer [UEL_SYSPOOLS_LLIST_NODE_POOL_SIZE] |
| The budder used to store llist node pointers in the llist node pool queue. | |
| -uel_objpool_t | llist_node_pool |
| The llist node pool object. Contains all llist nodes used by the core. | |
A container for the system pools.
-The syspools object is meant as a container for the internal system pools. It is a safe interface to the pools, acquiring and releasing objects on demand.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structsyspools__coll__graph.map b/docs/html/structsyspools__coll__graph.map
deleted file mode 100644
index dc4ade9..0000000
--- a/docs/html/structsyspools__coll__graph.map
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/docs/html/structsyspools__coll__graph.md5 b/docs/html/structsyspools__coll__graph.md5
deleted file mode 100644
index 17e49a8..0000000
--- a/docs/html/structsyspools__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-543b0027629887388e0da4164bed7fca
\ No newline at end of file
diff --git a/docs/html/structsyspools__coll__graph.png b/docs/html/structsyspools__coll__graph.png
deleted file mode 100644
index f12b826..0000000
Binary files a/docs/html/structsyspools__coll__graph.png and /dev/null differ
diff --git a/docs/html/structsysqueues.html b/docs/html/structsysqueues.html
deleted file mode 100644
index 8b9db2f..0000000
--- a/docs/html/structsysqueues.html
+++ /dev/null
@@ -1,152 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A container for the system's internal queues. - More...
-
-Data Fields | |
| -void * | event_queue_buffer [UEL_SYSQUEUES_EVENT_QUEUE_SIZE] |
| The event queue buffer. | |
| uel_cqueue_t | event_queue |
| The application's event queue. More... | |
| -void * | schedule_queue_buffer [UEL_SYSQUEUES_SCHEDULE_QUEUE_SIZE] |
| The schedule queue buffer. | |
| uel_cqueue_t | schedule_queue |
| The application's schedule queue. More... | |
A container for the system's internal queues.
-This module conveniently declares and contains the object queues necessary for internal operation of the application.
-It also encapsulate manipulation of shared memory in critical sections. All of its functions are safe, except for uel_sysqueues_init.
| uel_cqueue_t uel_sysqueues_t::event_queue | -
The application's event queue.
-Holds events ready to be processed on the next runloop.
- -| uel_cqueue_t uel_sysqueues_t::schedule_queue | -
The application's schedule queue.
-Hold events already processed by the runloop but fit for rescheduling at the scheduler.
- -
- 1.8.17
-
-
-
diff --git a/docs/html/structsysqueues__coll__graph.map b/docs/html/structsysqueues__coll__graph.map
deleted file mode 100644
index 2ae2b5a..0000000
--- a/docs/html/structsysqueues__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structsysqueues__coll__graph.md5 b/docs/html/structsysqueues__coll__graph.md5
deleted file mode 100644
index cce730a..0000000
--- a/docs/html/structsysqueues__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-2f1862db14e6dccc088d694a7562fc75
\ No newline at end of file
diff --git a/docs/html/structsysqueues__coll__graph.png b/docs/html/structsysqueues__coll__graph.png
deleted file mode 100644
index a78a1f2..0000000
Binary files a/docs/html/structsysqueues__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__application.html b/docs/html/structuel__application.html
deleted file mode 100644
index 7682e4e..0000000
--- a/docs/html/structuel__application.html
+++ /dev/null
@@ -1,145 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Top-level container for µEvLoop'd application. - More...
-
-Data Fields | |
| -uel_module_t ** | registry |
| The modules managed by this application. | |
| -size_t | registry_size |
| The number of modules managed by this application. | |
| -uel_syspools_t | pools |
| Holds the system pools: events and llist nodes. | |
| -uel_sysqueues_t | queues |
| Holds the system event queues. | |
| -uel_evloop_t | event_loop |
| The application's event loop. | |
| -uel_scheduer_t | scheduler |
| The applications's scheduler;. | |
| -uel_signal_relay_t | relay |
| Unused. | |
| -uel_llist_t | relay_buffer [UEL_APP_EVENT_COUNT] |
| Unused. | |
| -bool | run_scheduler |
| Marks when it's time to wake the scheduler. | |
Top-level container for µEvLoop'd application.
-The application module is not necessary, but it does facilitate creating and managing the state of a µEvLoop application. It contains all the system insternals and manages the scheduler and event loops queues automatically.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__application__coll__graph.map b/docs/html/structuel__application__coll__graph.map
deleted file mode 100644
index 3d31162..0000000
--- a/docs/html/structuel__application__coll__graph.map
+++ /dev/null
@@ -1,12 +0,0 @@
-
diff --git a/docs/html/structuel__application__coll__graph.md5 b/docs/html/structuel__application__coll__graph.md5
deleted file mode 100644
index c07a1dc..0000000
--- a/docs/html/structuel__application__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-900f00f0e16cafca74139c9f275822ca
\ No newline at end of file
diff --git a/docs/html/structuel__application__coll__graph.png b/docs/html/structuel__application__coll__graph.png
deleted file mode 100644
index f6f8372..0000000
Binary files a/docs/html/structuel__application__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__autopool.html b/docs/html/structuel__autopool.html
deleted file mode 100644
index 7dcfc85..0000000
--- a/docs/html/structuel__autopool.html
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Automatic pools are wrappers to object pools. They manage the acquisition and release cycle from objects issued at the pool by wrapping them in automatic pointers. - More...
-
-Data Fields | |
| -uel_objpool_t | autoptr_pool |
| The object pool that holds autopointers. | |
| -uel_closure_t | constructor |
| The constructor closure. | |
| -uel_closure_t | destructor |
| The destructor closure. | |
Automatic pools are wrappers to object pools. They manage the acquisition and release cycle from objects issued at the pool by wrapping them in automatic pointers.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__autopool__coll__graph.map b/docs/html/structuel__autopool__coll__graph.map
deleted file mode 100644
index 23bcd45..0000000
--- a/docs/html/structuel__autopool__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__autopool__coll__graph.md5 b/docs/html/structuel__autopool__coll__graph.md5
deleted file mode 100644
index 6b2ab7e..0000000
--- a/docs/html/structuel__autopool__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-0cffaae5a7e84b37f60adf63e1cf4449
\ No newline at end of file
diff --git a/docs/html/structuel__autopool__coll__graph.png b/docs/html/structuel__autopool__coll__graph.png
deleted file mode 100644
index 7d04566..0000000
Binary files a/docs/html/structuel__autopool__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__autoptr.html b/docs/html/structuel__autoptr.html
deleted file mode 100644
index 3bc17a4..0000000
--- a/docs/html/structuel__autoptr.html
+++ /dev/null
@@ -1,115 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Automatic pointers are pointers wrapped by information of where they were issued. - More...
- -#include <automatic-pool.h>
-Data Fields | |
| -void * | object |
| A pointer to the wrapped object. | |
| -struct uel_autopool * | source |
| The pool where the autoptr object was issued. | |
Automatic pointers are pointers wrapped by information of where they were issued.
-Upon deallocation, an object wrapped by an autoptr is automatically returned to its original pool. Automatic pointers are meant to be pooled themselves.
-The programmer can safely cast a uel_autoptr_t to a void * or a pointer to whatever type the wrapped object is.
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__autoptr__coll__graph.map b/docs/html/structuel__autoptr__coll__graph.map
deleted file mode 100644
index be4180c..0000000
--- a/docs/html/structuel__autoptr__coll__graph.map
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/docs/html/structuel__autoptr__coll__graph.md5 b/docs/html/structuel__autoptr__coll__graph.md5
deleted file mode 100644
index 924b488..0000000
--- a/docs/html/structuel__autoptr__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-49aad00ddf46c9c838871f01df161d5b
\ No newline at end of file
diff --git a/docs/html/structuel__autoptr__coll__graph.png b/docs/html/structuel__autoptr__coll__graph.png
deleted file mode 100644
index 9530bb5..0000000
Binary files a/docs/html/structuel__autoptr__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__closure.html b/docs/html/structuel__closure.html
deleted file mode 100644
index 332b08f..0000000
--- a/docs/html/structuel__closure.html
+++ /dev/null
@@ -1,111 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines a closure, a tuple <function, context, destructor> - More...
-
-Data Fields | |
| -uel_closure_function_t | function |
| The function to be run when the closure is invoked. Must take two pointers ar arguments, one for the context and one for closure parameters. Must return a void pointer. | |
| -void * | context |
| The context supplied to the closure durint creation. This context will be available during the function execution. | |
Defines a closure, a tuple <function, context, destructor>
-A closure is a data structure that binds some function to a predetermined context. When the function is run, this context will be available to the function body.
-When invoking the closure, additional parameters may be passed along and will also be available to the function body. The function can also return a value that will be passed back by the uel_closure_invoke function.
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__closure__coll__graph.map b/docs/html/structuel__closure__coll__graph.map
deleted file mode 100644
index 07d3c8f..0000000
--- a/docs/html/structuel__closure__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__closure__coll__graph.md5 b/docs/html/structuel__closure__coll__graph.md5
deleted file mode 100644
index dd4e898..0000000
--- a/docs/html/structuel__closure__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-7c7f0ce0853771875e20de9352f83409
\ No newline at end of file
diff --git a/docs/html/structuel__closure__coll__graph.png b/docs/html/structuel__closure__coll__graph.png
deleted file mode 100644
index 0089e8c..0000000
Binary files a/docs/html/structuel__closure__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__conditional.html b/docs/html/structuel__conditional.html
deleted file mode 100644
index 2b2af5c..0000000
--- a/docs/html/structuel__conditional.html
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Conditionals are constructs that provide functional flow control. - More...
-
-Data Fields | |
| -uel_closure_t | test |
A closure that, based on its input, should return true or false. | |
| -uel_closure_t | if_true |
The closure that will be invoked if the test closure returns true | |
| -uel_closure_t | if_false |
The closure that will be invoked if the test closure returns false | |
Conditionals are constructs that provide functional flow control.
-A conditional is defined by a tuple <test, if_true, if_false> of closures. When applied to some input, this input is passed to the test closure. Based on its returned value, one of the other closures is invoked.
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__conditional__coll__graph.map b/docs/html/structuel__conditional__coll__graph.map
deleted file mode 100644
index 0da3d82..0000000
--- a/docs/html/structuel__conditional__coll__graph.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/structuel__conditional__coll__graph.md5 b/docs/html/structuel__conditional__coll__graph.md5
deleted file mode 100644
index 139b978..0000000
--- a/docs/html/structuel__conditional__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-375c4a3f7b1a3c5410efd119015b8515
\ No newline at end of file
diff --git a/docs/html/structuel__conditional__coll__graph.png b/docs/html/structuel__conditional__coll__graph.png
deleted file mode 100644
index c4262c9..0000000
Binary files a/docs/html/structuel__conditional__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__cqueue.html b/docs/html/structuel__cqueue.html
deleted file mode 100644
index 585081b..0000000
--- a/docs/html/structuel__cqueue.html
+++ /dev/null
@@ -1,150 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines a circular queue of void pointers. - More...
-
-Data Fields | |
| -void ** | buffer |
| The buffer that will contain the enqueued values. | |
| -uintptr_t | size |
| The size of the queue. Must be a power of two. | |
| uintptr_t | mask |
| -uintptr_t | tail |
| The position that indicates where the oldest enqueued element is. | |
| uintptr_t | count |
Defines a circular queue of void pointers.
-The circular queue implementation provided is a fast and memory efficient FIFO data structure that holds void pointers.
-Its capacity is required to be a power of two. This makes possible to use fast modulo-2 arithmetic when dealing with the queue indices.
-| uintptr_t uel_cqueue_t::count | -
The count of enqueued elements. New elements are put at (tail + count) % size.
- -| uintptr_t uel_cqueue_t::mask | -
The mask used to wrap the indices around the capacity of the queue when they are incremented during pushs/pops
- -
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__cqueue__coll__graph.map b/docs/html/structuel__cqueue__coll__graph.map
deleted file mode 100644
index 1e962b0..0000000
--- a/docs/html/structuel__cqueue__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__cqueue__coll__graph.md5 b/docs/html/structuel__cqueue__coll__graph.md5
deleted file mode 100644
index bf01c0c..0000000
--- a/docs/html/structuel__cqueue__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-890c7140b19c0eef71bc1827505e48f6
\ No newline at end of file
diff --git a/docs/html/structuel__cqueue__coll__graph.png b/docs/html/structuel__cqueue__coll__graph.png
deleted file mode 100644
index b2122e1..0000000
Binary files a/docs/html/structuel__cqueue__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__evloop.html b/docs/html/structuel__evloop.html
deleted file mode 100644
index e89c0ff..0000000
--- a/docs/html/structuel__evloop.html
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
The event loop object. - More...
-
-Data Fields | |
| -uel_syspools_t * | pools |
| Reference to the system's pools. | |
| -uel_sysqueues_t * | queues |
| Reference to the system's queues. | |
| -uel_llist_t | observers |
| Stores references to values to be observed. | |
The event loop object.
-This object represents an event loop. It is operated primarily by the system internal queues:
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__evloop__coll__graph.map b/docs/html/structuel__evloop__coll__graph.map
deleted file mode 100644
index 61f28d3..0000000
--- a/docs/html/structuel__evloop__coll__graph.map
+++ /dev/null
@@ -1,6 +0,0 @@
-
diff --git a/docs/html/structuel__evloop__coll__graph.md5 b/docs/html/structuel__evloop__coll__graph.md5
deleted file mode 100644
index db86e79..0000000
--- a/docs/html/structuel__evloop__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-2c976f6b381641d0288180db180fc4e6
\ No newline at end of file
diff --git a/docs/html/structuel__evloop__coll__graph.png b/docs/html/structuel__evloop__coll__graph.png
deleted file mode 100644
index fa6d352..0000000
Binary files a/docs/html/structuel__evloop__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__func__mapper.html b/docs/html/structuel__func__mapper.html
deleted file mode 100644
index 906ec94..0000000
--- a/docs/html/structuel__func__mapper.html
+++ /dev/null
@@ -1,114 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Maps elements of an iterator to an area of memory. Each element is assigned to a void pointer slot.
- More...
-Data Fields | |
| -uel_iterator_t * | iterator |
| The iterator that enumerates the elements to be mapped. | |
| -void ** | destination |
| The area of memory to where elements will be mapped. | |
| -size_t | limit |
| The maximum size of slots to be mapped to. | |
Maps elements of an iterator to an area of memory. Each element is assigned to a void pointer slot.
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__func__mapper__coll__graph.map b/docs/html/structuel__func__mapper__coll__graph.map
deleted file mode 100644
index d71fddb..0000000
--- a/docs/html/structuel__func__mapper__coll__graph.map
+++ /dev/null
@@ -1,6 +0,0 @@
-
diff --git a/docs/html/structuel__func__mapper__coll__graph.md5 b/docs/html/structuel__func__mapper__coll__graph.md5
deleted file mode 100644
index d850eb8..0000000
--- a/docs/html/structuel__func__mapper__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-a6373462821e006b680d95dbbd3bdd43
\ No newline at end of file
diff --git a/docs/html/structuel__func__mapper__coll__graph.png b/docs/html/structuel__func__mapper__coll__graph.png
deleted file mode 100644
index 92eae82..0000000
Binary files a/docs/html/structuel__func__mapper__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__iterator.html b/docs/html/structuel__iterator.html
deleted file mode 100644
index 939f018..0000000
--- a/docs/html/structuel__iterator.html
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Iterators are data structures that wrap arbitrary collections of data and define ways of enumerating them. - More...
-
-Data Fields | |
| void *(* | next )(uel_iterator_t *, void *) |
| The iteration function assigned to this iterator type. More... | |
| -void * | collection |
| A reference to the collection being iterated. | |
Iterators are data structures that wrap arbitrary collections of data and define ways of enumerating them.
-This is an unspecialised structure that should be augumented with actual behaviour implementation.
-In order to specialise it, create a struct that holds whatever state is meaningful to iteration and has a uel_iterator_t as its first member. Then, whenever needed, cast the iterator to your custom type.
| void*(* uel_iterator_t::next) (uel_iterator_t *, void *) | -
The iteration function assigned to this iterator type.
-This is the actual implementation of the iteration algorithm. It takes a reference to the iterator and the last accessed element's address and returns a reference to the next element.
-To resquest the first collection item, pass NULL as the last element parameter. When this function returns NULL, there are no more elements in the collection to be iterated over.
- -
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__iterator__array.html b/docs/html/structuel__iterator__array.html
deleted file mode 100644
index fe85d3e..0000000
--- a/docs/html/structuel__iterator__array.html
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A specialised iterator suitable for iterating over arrays of arbitrary data. - More...
-
-Data Fields | |
| -uel_iterator_t | base |
| The base iterator interface. | |
| -size_t | item_count |
| The number of elements in the array. | |
| -size_t | item_size |
| The size of each element in the array. | |
A specialised iterator suitable for iterating over arrays of arbitrary data.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__iterator__array__coll__graph.map b/docs/html/structuel__iterator__array__coll__graph.map
deleted file mode 100644
index e362b53..0000000
--- a/docs/html/structuel__iterator__array__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__iterator__array__coll__graph.md5 b/docs/html/structuel__iterator__array__coll__graph.md5
deleted file mode 100644
index 545f52f..0000000
--- a/docs/html/structuel__iterator__array__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-2180149a5adda8e95803573fae71813d
\ No newline at end of file
diff --git a/docs/html/structuel__iterator__array__coll__graph.png b/docs/html/structuel__iterator__array__coll__graph.png
deleted file mode 100644
index 1e87a47..0000000
Binary files a/docs/html/structuel__iterator__array__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__iterator__coll__graph.map b/docs/html/structuel__iterator__coll__graph.map
deleted file mode 100644
index 963e281..0000000
--- a/docs/html/structuel__iterator__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__iterator__coll__graph.md5 b/docs/html/structuel__iterator__coll__graph.md5
deleted file mode 100644
index c5d1631..0000000
--- a/docs/html/structuel__iterator__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-d39bd3026ffd5bab7db032a7e1c0b566
\ No newline at end of file
diff --git a/docs/html/structuel__iterator__coll__graph.png b/docs/html/structuel__iterator__coll__graph.png
deleted file mode 100644
index 8f3a782..0000000
Binary files a/docs/html/structuel__iterator__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__llist.html b/docs/html/structuel__llist.html
deleted file mode 100644
index dc083b4..0000000
--- a/docs/html/structuel__llist.html
+++ /dev/null
@@ -1,113 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines a linked list. If it is empty, head == tail == NULL. Pushing or popping from both the head or tail is always O(1). - More...
-
-Data Fields | |
| -uel_llist_node_t * | head |
| A pointer to the head of the list. Is NULL when the list is empty. | |
| -uel_llist_node_t * | tail |
| A pointer to the tail of the list. Is NULL when the list is empty. | |
| -uintptr_t | count |
| The count of enqueued nodes. | |
Defines a linked list. If it is empty, head == tail == NULL. Pushing or popping from both the head or tail is always O(1).
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__llist__coll__graph.map b/docs/html/structuel__llist__coll__graph.map
deleted file mode 100644
index 423bc36..0000000
--- a/docs/html/structuel__llist__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__llist__coll__graph.md5 b/docs/html/structuel__llist__coll__graph.md5
deleted file mode 100644
index 2198477..0000000
--- a/docs/html/structuel__llist__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-e4dad2330e9ffbfb884106f2c3c3076f
\ No newline at end of file
diff --git a/docs/html/structuel__llist__coll__graph.png b/docs/html/structuel__llist__coll__graph.png
deleted file mode 100644
index d67e890..0000000
Binary files a/docs/html/structuel__llist__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__llist__node.html b/docs/html/structuel__llist__node.html
deleted file mode 100644
index 5ec9712..0000000
--- a/docs/html/structuel__llist__node.html
+++ /dev/null
@@ -1,109 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines a node of the linked list. Holds a void pointer. - More...
-
-Data Fields | |
| -void * | value |
| The value of the node, as a void pointer. | |
| -uel_llist_node_t * | next |
| The next node in the list. | |
Defines a node of the linked list. Holds a void pointer.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__llist__node__coll__graph.map b/docs/html/structuel__llist__node__coll__graph.map
deleted file mode 100644
index 41d402e..0000000
--- a/docs/html/structuel__llist__node__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__llist__node__coll__graph.md5 b/docs/html/structuel__llist__node__coll__graph.md5
deleted file mode 100644
index a303836..0000000
--- a/docs/html/structuel__llist__node__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-00e396b6bf554cf50e138bd2cfb28847
\ No newline at end of file
diff --git a/docs/html/structuel__llist__node__coll__graph.png b/docs/html/structuel__llist__node__coll__graph.png
deleted file mode 100644
index 19da0cb..0000000
Binary files a/docs/html/structuel__llist__node__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__module.html b/docs/html/structuel__module.html
deleted file mode 100644
index fa0cc01..0000000
--- a/docs/html/structuel__module.html
+++ /dev/null
@@ -1,155 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A module is an isolated unit of behaviour with lifecycle hooks. - More...
-
-Data Fields | |
| uel_module_hook_t | config |
| uel_module_hook_t | launch |
| -struct uel_application * | app |
| Keeps a reference to the application onto which the module is loaded. | |
A module is an isolated unit of behaviour with lifecycle hooks.
-Modules can serve as a variety of purposes:
-Modules are meant to be singletons and user extendable.
-| uel_module_hook_t uel_module_t::config | -
The config hook should be used for any setup of the module dependencies. It fires after the module has been fully initialised, but may still be in an inconsistent state.
- -| uel_module_hook_t uel_module_t::launch | -
The launch hook is used to start a module. The application will only fire it once all loaded modules are both initialised and configurated (i.e. config hook has been called).
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__module__coll__graph.map b/docs/html/structuel__module__coll__graph.map
deleted file mode 100644
index a13c991..0000000
--- a/docs/html/structuel__module__coll__graph.map
+++ /dev/null
@@ -1,13 +0,0 @@
-
diff --git a/docs/html/structuel__module__coll__graph.md5 b/docs/html/structuel__module__coll__graph.md5
deleted file mode 100644
index ac53222..0000000
--- a/docs/html/structuel__module__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-20072b9c02eb85c766a0774b4210ef2d
\ No newline at end of file
diff --git a/docs/html/structuel__module__coll__graph.png b/docs/html/structuel__module__coll__graph.png
deleted file mode 100644
index 0fba8ca..0000000
Binary files a/docs/html/structuel__module__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__objpool.html b/docs/html/structuel__objpool.html
deleted file mode 100644
index 731534c..0000000
--- a/docs/html/structuel__objpool.html
+++ /dev/null
@@ -1,111 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Pre-allocated memory bound to speciffic types suitable for providing dynamic object management in the stack. - More...
-
-Data Fields | |
| -uint8_t * | buffer |
| The buffer that contains each object managed by this pool. | |
| -uel_cqueue_t | queue |
| The queue containing the addresses for each object in the pool. | |
Pre-allocated memory bound to speciffic types suitable for providing dynamic object management in the stack.
-Object pools are arrays of objects that are pre-allocated in the stack at compile time as an alternative to runtime memory allocation for dynamic object management.
-To efficiently release and acquire objects from a pool, their addresses are kept in a circular queue that is fully populated during initialisation.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__objpool__coll__graph.map b/docs/html/structuel__objpool__coll__graph.map
deleted file mode 100644
index a20ce43..0000000
--- a/docs/html/structuel__objpool__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__objpool__coll__graph.md5 b/docs/html/structuel__objpool__coll__graph.md5
deleted file mode 100644
index 5634507..0000000
--- a/docs/html/structuel__objpool__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-13b019f3abeb56296f25af9f5a776f87
\ No newline at end of file
diff --git a/docs/html/structuel__objpool__coll__graph.png b/docs/html/structuel__objpool__coll__graph.png
deleted file mode 100644
index 797d281..0000000
Binary files a/docs/html/structuel__objpool__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__pipeline.html b/docs/html/structuel__pipeline.html
deleted file mode 100644
index 4783021..0000000
--- a/docs/html/structuel__pipeline.html
+++ /dev/null
@@ -1,110 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A pipeline is an ordered closure list to be run in sequence. - More...
-
-Data Fields | |
| -uel_closure_t * | closures |
| A reference to an array of closures to be run. | |
| -size_t | count |
| The number of closures in the array. | |
A pipeline is an ordered closure list to be run in sequence.
-Pipelines contain an ordered list of closures. When applied to some initial parameter, each closure is invoked with the previous one's return value as parameter.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__pipeline__coll__graph.map b/docs/html/structuel__pipeline__coll__graph.map
deleted file mode 100644
index 76760d9..0000000
--- a/docs/html/structuel__pipeline__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__pipeline__coll__graph.md5 b/docs/html/structuel__pipeline__coll__graph.md5
deleted file mode 100644
index 6031cba..0000000
--- a/docs/html/structuel__pipeline__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-b24c94c6c78cea55c17360c46bc45bc0
\ No newline at end of file
diff --git a/docs/html/structuel__pipeline__coll__graph.png b/docs/html/structuel__pipeline__coll__graph.png
deleted file mode 100644
index f0e478b..0000000
Binary files a/docs/html/structuel__pipeline__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__promise.html b/docs/html/structuel__promise.html
deleted file mode 100644
index 967b940..0000000
--- a/docs/html/structuel__promise.html
+++ /dev/null
@@ -1,133 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A promise is association of an asynchronous operation to the possible execution paths that follow its resolution. It is also a holder for the value it was settled with. - More...
-
-Data Fields | |
| -struct uel_promise_store * | source |
| The promise store from where this promise was issued. | |
| -uel_promise_state_t | state |
| The current state of this promise. | |
| -void * | value |
| The value this promise holds. Only meaningful if already settled. | |
| -uel_promise_segment_t * | first_segment |
| The first segment to be processed when this promise settles. | |
| -uel_promise_segment_t * | last_segment |
| The last segment to be processed when this promise settles. | |
A promise is association of an asynchronous operation to the possible execution paths that follow its resolution. It is also a holder for the value it was settled with.
-A promise is an object that can be in three different states:
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__promise__coll__graph.map b/docs/html/structuel__promise__coll__graph.map
deleted file mode 100644
index 28e2189..0000000
--- a/docs/html/structuel__promise__coll__graph.map
+++ /dev/null
@@ -1,8 +0,0 @@
-
diff --git a/docs/html/structuel__promise__coll__graph.md5 b/docs/html/structuel__promise__coll__graph.md5
deleted file mode 100644
index 9876c18..0000000
--- a/docs/html/structuel__promise__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-78528ae9e887413aec85924f7452ce25
\ No newline at end of file
diff --git a/docs/html/structuel__promise__coll__graph.png b/docs/html/structuel__promise__coll__graph.png
deleted file mode 100644
index d6231e0..0000000
Binary files a/docs/html/structuel__promise__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__promise__segment.html b/docs/html/structuel__promise__segment.html
deleted file mode 100644
index 13ed347..0000000
--- a/docs/html/structuel__promise__segment.html
+++ /dev/null
@@ -1,116 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Defines a single synchronous operation to be invoked when the promise is either resolved or rejected. - More...
-
-Data Fields | |
| -uel_closure_t | resolve |
| The closure to be invoked when the promise is resolved. | |
| -uel_closure_t | reject |
| The closure to be invoked when the promise is rejected. | |
| -uel_promise_segment_t * | next |
| The next synchronous segment to be processed. | |
Defines a single synchronous operation to be invoked when the promise is either resolved or rejected.
-A promise segment is a data structure that defines how to process a value yielded by a promise when it resolves or rejects.
-Segments contain two closures, representing success and error execution paths. Once the promise containing a segment is settled, depending on its state, either closure is invoked with the promise as parameter.
-If a handler closure returns anything different that NULL, it's assumed to be a promise pointer to be awaited for.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__promise__segment__coll__graph.map b/docs/html/structuel__promise__segment__coll__graph.map
deleted file mode 100644
index d1d85d9..0000000
--- a/docs/html/structuel__promise__segment__coll__graph.map
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/html/structuel__promise__segment__coll__graph.md5 b/docs/html/structuel__promise__segment__coll__graph.md5
deleted file mode 100644
index 9005347..0000000
--- a/docs/html/structuel__promise__segment__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-bdb8f904f3790b92535bb8b16c8670e3
\ No newline at end of file
diff --git a/docs/html/structuel__promise__segment__coll__graph.png b/docs/html/structuel__promise__segment__coll__graph.png
deleted file mode 100644
index 57fe5e1..0000000
Binary files a/docs/html/structuel__promise__segment__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__promise__store.html b/docs/html/structuel__promise__store.html
deleted file mode 100644
index e3bbfe2..0000000
--- a/docs/html/structuel__promise__store.html
+++ /dev/null
@@ -1,108 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
An issuer of promises. Contains references to pools for promises and segments. - More...
-
-Data Fields | |
| -uel_objpool_t * | promise_pool |
| A reference to the promise pool. | |
| -uel_objpool_t * | segment_pool |
| A reference to the segment pool. | |
An issuer of promises. Contains references to pools for promises and segments.
-
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__promise__store__coll__graph.map b/docs/html/structuel__promise__store__coll__graph.map
deleted file mode 100644
index 853e662..0000000
--- a/docs/html/structuel__promise__store__coll__graph.map
+++ /dev/null
@@ -1,4 +0,0 @@
-
diff --git a/docs/html/structuel__promise__store__coll__graph.md5 b/docs/html/structuel__promise__store__coll__graph.md5
deleted file mode 100644
index 75ca2a9..0000000
--- a/docs/html/structuel__promise__store__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-3b63650a18ab5fefc8cb220e78069068
\ No newline at end of file
diff --git a/docs/html/structuel__promise__store__coll__graph.png b/docs/html/structuel__promise__store__coll__graph.png
deleted file mode 100644
index eda5f13..0000000
Binary files a/docs/html/structuel__promise__store__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__scheduler.html b/docs/html/structuel__scheduler.html
deleted file mode 100644
index b2d1bd7..0000000
--- a/docs/html/structuel__scheduler.html
+++ /dev/null
@@ -1,158 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
The scheduler object. - More...
-
-Data Fields | |
| uel_llist_t | timer_list |
| Scheduled timers linked list. More... | |
| uel_llist_t | pause_list |
| Paused timers linked list. More... | |
| -uel_syspools_t * | pools |
| Reference to the system's pools. | |
| -uel_sysqueues_t * | queues |
| Reference to the system's queues. | |
| -volatile uint32_t | timer |
Internal timer. Must be updated via uel_sch_update_timer() | |
The scheduler object.
-This object keeps track of time run since the application was launched. It also keeps a queue of events due to be processed sometime in the future.
-It feeds and is fed by the system queues. Timers due to be processed are put in the outbound event queue. Timers awaiting scheduling are put in the inbound schedule queue.
-| uel_llist_t uel_scheduer_t::pause_list | -
Paused timers linked list.
-Holds events that had been scheduled but has been paused by the programmer. This is scanned for resumed timers every time uel_sch_manage_timers is called.
| uel_llist_t uel_scheduer_t::timer_list | -
Scheduled timers linked list.
-This linked list holds events/timers scheduled to be run in the future. Timers are inserted sorted by its due time, so it is always in execution order.
- -
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__scheduler__coll__graph.map b/docs/html/structuel__scheduler__coll__graph.map
deleted file mode 100644
index 85656e5..0000000
--- a/docs/html/structuel__scheduler__coll__graph.map
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/docs/html/structuel__scheduler__coll__graph.md5 b/docs/html/structuel__scheduler__coll__graph.md5
deleted file mode 100644
index d741683..0000000
--- a/docs/html/structuel__scheduler__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-90268898a2f4a67396fd301824d2d2c0
\ No newline at end of file
diff --git a/docs/html/structuel__scheduler__coll__graph.png b/docs/html/structuel__scheduler__coll__graph.png
deleted file mode 100644
index 7124d99..0000000
Binary files a/docs/html/structuel__scheduler__coll__graph.png and /dev/null differ
diff --git a/docs/html/structuel__signal__relay.html b/docs/html/structuel__signal__relay.html
deleted file mode 100644
index 985f8f9..0000000
--- a/docs/html/structuel__signal__relay.html
+++ /dev/null
@@ -1,148 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
Contains a signal vector and operates on in. - More...
-
-Data Fields | |
| uel_llist_t * | signal_vector |
| uel_sysqueues_t * | queues |
| -uel_syspools_t * | pools |
| A quick reference to the system's internal pools. | |
| -uintptr_t | width |
| The number of signals registered at this relay. | |
Contains a signal vector and operates on in.
-The signal relay is the central data structure involved in signal operation. It contains a signal vector, an array of linked lists, each associated to a particular signal.
-When a signal is listened for, the listener closure is added to the linked list corresponding to said signal. When that signal is emitted, each listener closure in the list is invoked.
-| uel_sysqueues_t* uel_signal_relay_t::queues | -
The system's internal queues. Upon emission, signals will be enqueued on one of these.
- -| uel_llist_t* uel_signal_relay_t::signal_vector | -
Contains the signal vector. Must be large enough to contain every signal bound to this relay.
- -
- 1.8.17
-
-
-
diff --git a/docs/html/structuel__signal__relay__coll__graph.map b/docs/html/structuel__signal__relay__coll__graph.map
deleted file mode 100644
index 200725e..0000000
--- a/docs/html/structuel__signal__relay__coll__graph.map
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/docs/html/structuel__signal__relay__coll__graph.md5 b/docs/html/structuel__signal__relay__coll__graph.md5
deleted file mode 100644
index 84acc34..0000000
--- a/docs/html/structuel__signal__relay__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-68fa086fe2954b73806e256621a6309e
\ No newline at end of file
diff --git a/docs/html/structuel__signal__relay__coll__graph.png b/docs/html/structuel__signal__relay__coll__graph.png
deleted file mode 100644
index 5e9c248..0000000
Binary files a/docs/html/structuel__signal__relay__coll__graph.png and /dev/null differ
diff --git a/docs/html/sync_off.png b/docs/html/sync_off.png
deleted file mode 100644
index 3b443fc..0000000
Binary files a/docs/html/sync_off.png and /dev/null differ
diff --git a/docs/html/sync_on.png b/docs/html/sync_on.png
deleted file mode 100644
index e08320f..0000000
Binary files a/docs/html/sync_on.png and /dev/null differ
diff --git a/docs/html/system-pools_8h.html b/docs/html/system-pools_8h.html
deleted file mode 100644
index df51b4e..0000000
--- a/docs/html/system-pools_8h.html
+++ /dev/null
@@ -1,315 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A container for the system's internal pools. -More...
-#include "uevloop/config.h"#include "uevloop/utils/linked-list.h"#include "uevloop/utils/object-pool.h"#include "uevloop/system/event.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_syspools_t |
| A container for the system pools. More... | |
-Macros | |
| -#define | UEL_SYSPOOLS_EVENT_POOL_SIZE (1<<UEL_SYSPOOLS_EVENT_POOL_SIZE_LOG2N) |
Unrolls the UEL_SYSPOOLS_EVENT_POOL_SIZE_LOG2N value to its power-of-two form. | |
| -#define | UEL_SYSPOOLS_LLIST_NODE_POOL_SIZE (1<<UEL_SYSPOOLS_LLIST_NODE_POOL_SIZE_LOG2N) |
Unrolls the UEL_SYSPOOLS_LLIST_NODE_POOL_SIZE_LOG2N value to its power-of-two form. | |
-Functions | |
| void | uel_syspools_init (uel_syspools_t *pools) |
| Initialise the system pools. More... | |
| uel_event_t * | uel_syspools_acquire_event (uel_syspools_t *pools) |
| Acquires an event from the system pools. More... | |
| uel_llist_node_t * | uel_syspools_acquire_llist_node (uel_syspools_t *pools) |
| Acquires a linked list node from the system pools. More... | |
| bool | uel_syspools_release_event (uel_syspools_t *pools, uel_event_t *event) |
| Releases an event to the system pools. More... | |
| bool | uel_syspools_release_llist_node (uel_syspools_t *pools, uel_llist_node_t *node) |
| Releases a linked list node to the system pools. More... | |
A container for the system's internal pools.
-| uel_event_t* uel_syspools_acquire_event | -( | -uel_syspools_t * | -pools | ) | -- |
Acquires an event from the system pools.
-| pools | The uel_syspools_t instance |
| uel_llist_node_t* uel_syspools_acquire_llist_node | -( | -uel_syspools_t * | -pools | ) | -- |
Acquires a linked list node from the system pools.
-| pools | The uel_syspools_t instance |
| void uel_syspools_init | -( | -uel_syspools_t * | -pools | ) | -- |
Initialise the system pools.
-| pools | The uel_syspools_t instance |
| bool uel_syspools_release_event | -( | -uel_syspools_t * | -pools, | -
| - | - | uel_event_t * | -event | -
| - | ) | -- |
Releases an event to the system pools.
-| pools | The uel_syspools_t instance |
| event | The event to be released |
| bool uel_syspools_release_llist_node | -( | -uel_syspools_t * | -pools, | -
| - | - | uel_llist_node_t * | -node | -
| - | ) | -- |
Releases a linked list node to the system pools.
-| pools | The uel_syspools_t instance |
| node | The linked list node to be released |
- 1.8.17
-
-
-
diff --git a/docs/html/system-pools_8h__dep__incl.map b/docs/html/system-pools_8h__dep__incl.map
deleted file mode 100644
index ee66632..0000000
--- a/docs/html/system-pools_8h__dep__incl.map
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/docs/html/system-pools_8h__dep__incl.md5 b/docs/html/system-pools_8h__dep__incl.md5
deleted file mode 100644
index e8db9cb..0000000
--- a/docs/html/system-pools_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-89f968e26fb8e62329fce718ec3bdf77
\ No newline at end of file
diff --git a/docs/html/system-pools_8h__dep__incl.png b/docs/html/system-pools_8h__dep__incl.png
deleted file mode 100644
index 5f10bdc..0000000
Binary files a/docs/html/system-pools_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/system-pools_8h__incl.map b/docs/html/system-pools_8h__incl.map
deleted file mode 100644
index 5a2346c..0000000
--- a/docs/html/system-pools_8h__incl.map
+++ /dev/null
@@ -1,9 +0,0 @@
-
diff --git a/docs/html/system-pools_8h__incl.md5 b/docs/html/system-pools_8h__incl.md5
deleted file mode 100644
index 6e33aa1..0000000
--- a/docs/html/system-pools_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-16064ff3bab7157d82de6b2edc13286f
\ No newline at end of file
diff --git a/docs/html/system-pools_8h__incl.png b/docs/html/system-pools_8h__incl.png
deleted file mode 100644
index 701a832..0000000
Binary files a/docs/html/system-pools_8h__incl.png and /dev/null differ
diff --git a/docs/html/system-pools_8h_source.html b/docs/html/system-pools_8h_source.html
deleted file mode 100644
index 180bd0d..0000000
--- a/docs/html/system-pools_8h_source.html
+++ /dev/null
@@ -1,136 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/system-queues_8h.html b/docs/html/system-queues_8h.html
deleted file mode 100644
index d7b2cd6..0000000
--- a/docs/html/system-queues_8h.html
+++ /dev/null
@@ -1,373 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
A container for the system's internal queues. -More...
-#include "uevloop/system/event.h"#include "uevloop/config.h"#include "uevloop/utils/circular-queue.h"
Go to the source code of this file.
--Data Structures | |
| struct | uel_sysqueues_t |
| A container for the system's internal queues. More... | |
-Macros | |
| -#define | UEL_SYSQUEUES_EVENT_QUEUE_SIZE (1<<UEL_SYSQUEUES_EVENT_QUEUE_SIZE_LOG2N) |
Unrolls the UEL_SYSQUEUES_EVENT_QUEUE_SIZE_LOG2N value to its power-of-two form. | |
| -#define | UEL_SYSQUEUES_SCHEDULE_QUEUE_SIZE (1<<UEL_SYSQUEUES_SCHEDULE_QUEUE_SIZE_LOG2N) |
Unrolls the UEL_SYSQUEUES_SCHEDULE_QUEUE_SIZE_LOG2N value to its power-of-two form. | |
-Functions | |
| void | uel_sysqueues_init (uel_sysqueues_t *queues) |
| Initialises a new uel_sysqueues_t. More... | |
| void | uel_sysqueues_enqueue_event (uel_sysqueues_t *queues, uel_event_t *event) |
| Pushes an event into the event queue. More... | |
| uel_event_t * | uel_sysqueues_get_enqueued_event (uel_sysqueues_t *queues) |
| Pops an event from the event queue. More... | |
| uintptr_t | uel_sysqueues_count_enqueued_events (uel_sysqueues_t *queues) |
| Counts the number of elements in the event queue. More... | |
| void | uel_sysqueues_schedule_event (uel_sysqueues_t *queues, uel_event_t *event) |
| Pushes an event into the schedule queue. More... | |
| uel_event_t * | uel_sysqueues_get_scheduled_event (uel_sysqueues_t *queues) |
| Pops an event from the schedule queue. More... | |
| uintptr_t | uel_sysqueues_count_scheduled_events (uel_sysqueues_t *queues) |
| Counts the number of elements in the schedule queue. More... | |
A container for the system's internal queues.
-| uintptr_t uel_sysqueues_count_enqueued_events | -( | -uel_sysqueues_t * | -queues | ) | -- |
Counts the number of elements in the event queue.
-| queues | The uel_sysqueues_t instance whose event queue's elements should be counted |
| uintptr_t uel_sysqueues_count_scheduled_events | -( | -uel_sysqueues_t * | -queues | ) | -- |
Counts the number of elements in the schedule queue.
-| queues | The uel_sysqueues_t instance whose schedule queue's elements should be counted |
| void uel_sysqueues_enqueue_event | -( | -uel_sysqueues_t * | -queues, | -
| - | - | uel_event_t * | -event | -
| - | ) | -- |
Pushes an event into the event queue.
-This makes the event ready for colletion e processing by the event loop.
-| queues | The uel_sysqueues_t instance to be initialised |
| event | The event to be enqueued |
| uel_event_t* uel_sysqueues_get_enqueued_event | -( | -uel_sysqueues_t * | -queues | ) | -- |
Pops an event from the event queue.
-| queues | The uel_sysqueues_t instance from whose event queue the event must be popped. |
| uel_event_t* uel_sysqueues_get_scheduled_event | -( | -uel_sysqueues_t * | -queues | ) | -- |
Pops an event from the schedule queue.
-| queues | The uel_sysqueues_t instance from whose schedule queue the event must be popped. |
| void uel_sysqueues_init | -( | -uel_sysqueues_t * | -queues | ) | -- |
Initialises a new uel_sysqueues_t.
-| queues | The uel_sysqueues_t instance to be initialised |
| void uel_sysqueues_schedule_event | -( | -uel_sysqueues_t * | -queues, | -
| - | - | uel_event_t * | -event | -
| - | ) | -- |
Pushes an event into the schedule queue.
-This makes the event ready for collection and scheduling by the scheduler.
-| queues | The uel_sysqueues_t instance to be initialised |
| event | The event to be scheduled |
- 1.8.17
-
-
-
diff --git a/docs/html/system-queues_8h__dep__incl.map b/docs/html/system-queues_8h__dep__incl.map
deleted file mode 100644
index b09db09..0000000
--- a/docs/html/system-queues_8h__dep__incl.map
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/docs/html/system-queues_8h__dep__incl.md5 b/docs/html/system-queues_8h__dep__incl.md5
deleted file mode 100644
index b65c9a7..0000000
--- a/docs/html/system-queues_8h__dep__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-c886acddb0e67c23af2cb70a54b37136
\ No newline at end of file
diff --git a/docs/html/system-queues_8h__dep__incl.png b/docs/html/system-queues_8h__dep__incl.png
deleted file mode 100644
index 8da6782..0000000
Binary files a/docs/html/system-queues_8h__dep__incl.png and /dev/null differ
diff --git a/docs/html/system-queues_8h__incl.map b/docs/html/system-queues_8h__incl.map
deleted file mode 100644
index 4076ea7..0000000
--- a/docs/html/system-queues_8h__incl.map
+++ /dev/null
@@ -1,8 +0,0 @@
-
diff --git a/docs/html/system-queues_8h__incl.md5 b/docs/html/system-queues_8h__incl.md5
deleted file mode 100644
index ae675b1..0000000
--- a/docs/html/system-queues_8h__incl.md5
+++ /dev/null
@@ -1 +0,0 @@
-25fea88be1f9536579cb54a9a6888687
\ No newline at end of file
diff --git a/docs/html/system-queues_8h__incl.png b/docs/html/system-queues_8h__incl.png
deleted file mode 100644
index d868ecb..0000000
Binary files a/docs/html/system-queues_8h__incl.png and /dev/null differ
diff --git a/docs/html/system-queues_8h_source.html b/docs/html/system-queues_8h_source.html
deleted file mode 100644
index bccc86d..0000000
--- a/docs/html/system-queues_8h_source.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
- 1.8.17
-
-
-
diff --git a/docs/html/tab_a.png b/docs/html/tab_a.png
deleted file mode 100644
index 3b725c4..0000000
Binary files a/docs/html/tab_a.png and /dev/null differ
diff --git a/docs/html/tab_b.png b/docs/html/tab_b.png
deleted file mode 100644
index e2b4a86..0000000
Binary files a/docs/html/tab_b.png and /dev/null differ
diff --git a/docs/html/tab_h.png b/docs/html/tab_h.png
deleted file mode 100644
index fd5cb70..0000000
Binary files a/docs/html/tab_h.png and /dev/null differ
diff --git a/docs/html/tab_s.png b/docs/html/tab_s.png
deleted file mode 100644
index ab478c9..0000000
Binary files a/docs/html/tab_s.png and /dev/null differ
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
deleted file mode 100644
index 7d45d36..0000000
--- a/docs/html/tabs.css
+++ /dev/null
@@ -1 +0,0 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0px/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0px 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0px 1px 1px rgba(255,255,255,0.9);color:#283A5D;outline:none}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a.current{color:#D23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media (min-width: 768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283A5D transparent transparent transparent;background:transparent;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0px 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a:hover span.sub-arrow{border-color:#fff transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;border-radius:5px !important;box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent #fff}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #D23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#D23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}}
diff --git a/docs/html/unionevent_1_1uel__event__detail.html b/docs/html/unionevent_1_1uel__event__detail.html
deleted file mode 100644
index b0d6d84..0000000
--- a/docs/html/unionevent_1_1uel__event__detail.html
+++ /dev/null
@@ -1,144 +0,0 @@
-
-
-
-
-
-
-
-|
- µEvLoop
-
- A fast and lightweight event loop aimed at embedded platforms in C99.
- |
-
#include <event.h>
-Data Structures | |
| struct | uel_event_listener |
| Contains the context of a particular signal listener. More... | |
| struct | uel_event_observer |
| Contains the reference to an observer variable. More... | |
| struct | uel_event_signal |
Contains information related to an emitted signal. More... | |
| struct | uel_event_timer |
| Contains information suitable for scheduling an event at the scheduler. More... | |
-Data Fields | |
| -struct event::uel_event_detail::uel_event_timer | timer |
| The scheduling information of this event. Relevant only for timers. | |
| -struct event::uel_event_detail::uel_event_signal | signal |
| The emission information of this event. Relevant only for signals. | |
| -struct event::uel_event_detail::uel_event_listener | listener |
| The listening information of this event. Relevant only for signal listeners. | |
| -struct event::uel_event_detail::uel_event_observer | observer |
| The observing information of this event. Relevant only for observers. | |
Allows to compact many speciffic details on various event types on a single memory slot. Pertinent content depends on the type member value.
- 1.8.17
-
-
-
diff --git a/docs/html/unionevent_1_1uel__event__detail__coll__graph.map b/docs/html/unionevent_1_1uel__event__detail__coll__graph.map
deleted file mode 100644
index 0370e60..0000000
--- a/docs/html/unionevent_1_1uel__event__detail__coll__graph.map
+++ /dev/null
@@ -1,13 +0,0 @@
-
diff --git a/docs/html/unionevent_1_1uel__event__detail__coll__graph.md5 b/docs/html/unionevent_1_1uel__event__detail__coll__graph.md5
deleted file mode 100644
index 1806ca5..0000000
--- a/docs/html/unionevent_1_1uel__event__detail__coll__graph.md5
+++ /dev/null
@@ -1 +0,0 @@
-fbaa02c277245840306e3dd5a7ce84bd
\ No newline at end of file
diff --git a/docs/html/unionevent_1_1uel__event__detail__coll__graph.png b/docs/html/unionevent_1_1uel__event__detail__coll__graph.png
deleted file mode 100644
index 2eeb810..0000000
Binary files a/docs/html/unionevent_1_1uel__event__detail__coll__graph.png and /dev/null differ
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index 3abafac..0000000
--- a/docs/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-
diff --git a/include/uevloop/system/event.h b/include/uevloop/system/event.h
index d2cd5d3..3244611 100644
--- a/include/uevloop/system/event.h
+++ b/include/uevloop/system/event.h
@@ -34,7 +34,6 @@ enum uel_event_timer_status {
//! Alias to the uel_event_timer_status
typedef enum uel_event_timer_status uel_event_timer_status_t;
-
/** \brief Events are special messages passed around the core.
* They represent tasks to be run at some point by the system.
*
@@ -55,11 +54,13 @@ typedef enum uel_event_timer_status uel_event_timer_status_t;
* flag determines whether the signal should be able to fire multiple times or just once.
*/
typedef struct event uel_event_t;
+typedef void (*event_final_callback_t)(uel_event_t *);
struct event {
uel_event_type_t type; //!< The type of the event, as defined by `uel_event_type_t`
uel_closure_t closure; //!< The closure to be invoked a.k.a. the action to be run
void *value; //!< The value the closure should be invoked with
bool repeating; //!< Marks whether the event should be discarded after processing.
+ event_final_callback_t final_callback; //!< Get's called when all the listeners have been invoked.
//! Allows to compact many speciffic details on various event types on a single
//! memory slot. Pertinent content depends on the `type` member value.
diff --git a/include/uevloop/system/signal.h b/include/uevloop/system/signal.h
index 63b5191..54e4c37 100644
--- a/include/uevloop/system/signal.h
+++ b/include/uevloop/system/signal.h
@@ -114,6 +114,17 @@ void uel_signal_unlisten(uel_signal_listener_t listener);
*/
void uel_signal_emit(uel_signal_t signal, uel_signal_relay_t *relay, void *params);
+/** \brief Emits a signal at the supplied relay. Any closure listening to this
+ * signal will be asynchronously invoked. When all are invoked, call the final callback.
+ *
+ * \param signal The signal to be emitted
+ * \param relay The relay where the signal is registered
+ * \param params The parameters supplied to the listener's closure when it is
+ * invoked.
+ */
+void uel_signal_emit_with_final_callback(uel_signal_t signal, uel_signal_relay_t *relay, void *params,
+ event_final_callback_t final_callback);
+
/** \brief Attaches a non-repeating listener that resolves the provided promise
* upon emission.
*
diff --git a/src/system/event-loop.c b/src/system/event-loop.c
index 4dcf2a9..8718c8c 100644
--- a/src/system/event-loop.c
+++ b/src/system/event-loop.c
@@ -58,6 +58,12 @@ static inline void run_signal_event(uel_evloop_t *event_loop, uel_event_t *signa
uel_closure_t *closure = &closures[i];
uel_closure_invoke(closure, signal->value);
}
+
+ if (signal->final_callback != NULL)
+ {
+ signal->final_callback(signal);
+ }
+
for(unsigned int node_count = j, j = 0; j < node_count; j++){
uel_event_t *event = removed_nodes[j]->value;
uel_syspools_release_event(event_loop->pools, event);
diff --git a/src/system/event.c b/src/system/event.c
index 407c00c..a95ed01 100644
--- a/src/system/event.c
+++ b/src/system/event.c
@@ -10,6 +10,7 @@ void uel_event_config_closure(
void *value,
bool repeating
) {
+ event->final_callback = NULL;
event->type = UEL_CLOSURE_EVENT;
event->closure = *closure;
event->value = value;
@@ -22,6 +23,7 @@ void uel_event_config_signal(
uel_llist_t *listeners,
void *params
){
+ event->final_callback = NULL;
event->closure = uel_closure_create(NULL, NULL);
event->type = UEL_SIGNAL_EVENT;
event->detail.signal.value = signal;
@@ -30,6 +32,7 @@ void uel_event_config_signal(
}
void uel_event_config_signal_listener(uel_event_t *event, uel_closure_t *closure, bool repeating){
+ event->final_callback = NULL;
event->type = UEL_SIGNAL_LISTENER_EVENT;
event->closure = *closure;
event->repeating = repeating;
@@ -42,6 +45,7 @@ void uel_event_config_observer(
volatile uintptr_t *condition_var,
bool repeating
){
+ event->final_callback = NULL;
event->type = UEL_OBSERVER_EVENT;
event->closure = *closure;
event->repeating = repeating;
@@ -63,6 +67,7 @@ void uel_event_config_timer(
void *value,
uint32_t current_time
) {
+ event->final_callback = NULL;
event->type = UEL_TIMER_EVENT;
event->closure = *closure;
event->value = value;
diff --git a/src/system/signal.c b/src/system/signal.c
index 33e5fac..e8b329c 100644
--- a/src/system/signal.c
+++ b/src/system/signal.c
@@ -76,6 +76,22 @@ void uel_signal_emit(uel_signal_t signal, uel_signal_relay_t *relay, void *param
}
}
+void uel_signal_emit_with_final_callback(uel_signal_t signal, uel_signal_relay_t *relay, void *params,
+ event_final_callback_t final_callback)
+{
+ uel_llist_t *listeners = &relay->signal_vector[signal];
+ bool has_listeners = false;
+ UEL_CRITICAL_ENTER;
+ has_listeners = listeners->count > 0;
+ UEL_CRITICAL_EXIT;
+ if (has_listeners) {
+ uel_event_t *event = uel_syspools_acquire_event(relay->pools);
+ uel_event_config_signal(event, signal, listeners, params);
+ event->final_callback = final_callback;
+ uel_sysqueues_enqueue_event(relay->queues, event);
+ }
+}
+
uel_signal_listener_t uel_signal_resolve_promise(
uel_signal_t signal,
uel_signal_relay_t *relay,