diff --git a/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.html b/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.html index 513c9d7..bf067be 100644 --- a/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.html +++ b/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.html @@ -121,7 +121,8 @@  memory.h  Header file for memory management in Rishka applications.
  - runtime.h + runtime.h + Provides utilities for managing runtime operations within Rishka applications.
   spi.h  Header file for SPI (Serial Peripheral Interface) communication in Rishka applications.
diff --git a/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.js b/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.js index 7f0f1be..aa5e6c5 100644 --- a/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.js +++ b/docs/dir_6e8afc538eccbcb491711fd0cc7b9703.js @@ -7,7 +7,7 @@ var dir_6e8afc538eccbcb491711fd0cc7b9703 = [ "int.h", "int_8h.html", "int_8h" ], [ "io.h", "io_8h.html", "io_8h" ], [ "memory.h", "memory_8h.html", "memory_8h" ], - [ "runtime.h", "runtime_8h_source.html", null ], + [ "runtime.h", "runtime_8h.html", "runtime_8h" ], [ "spi.h", "spi_8h.html", "spi_8h" ], [ "sys.h", "sys_8h.html", "sys_8h" ], [ "types.h", "types_8h.html", "types_8h" ] diff --git a/docs/doxygen_crawl.html b/docs/doxygen_crawl.html index eb48e9a..4a7da2d 100644 --- a/docs/doxygen_crawl.html +++ b/docs/doxygen_crawl.html @@ -28,6 +28,7 @@ + diff --git a/docs/files.html b/docs/files.html index 9e6f28a..bc5f4fb 100644 --- a/docs/files.html +++ b/docs/files.html @@ -108,7 +108,7 @@  int.hHeader file for interrupt handling in Rishka applications  io.hHeader file for input/output operations in Rishka applications  memory.hHeader file for memory management in Rishka applications - runtime.h + runtime.hProvides utilities for managing runtime operations within Rishka applications  spi.hHeader file for SPI (Serial Peripheral Interface) communication in Rishka applications  sys.hHeader file for system utilities in Rishka applications  types.hHeader file for common data types used in Rishka applications diff --git a/docs/librishka_8h.html b/docs/librishka_8h.html index a805c5c..3231415 100644 --- a/docs/librishka_8h.html +++ b/docs/librishka_8h.html @@ -107,7 +107,7 @@ #include <librishka/int.h>
#include <librishka/io.h>
#include <librishka/memory.h>
-#include <librishka/runtime.h>
+#include <librishka/runtime.h>
#include <librishka/spi.h>
#include <librishka/sys.h>
#include <librishka/types.h>
diff --git a/docs/librishka_8h_source.html b/docs/librishka_8h_source.html index ef79599..f6f3179 100644 --- a/docs/librishka_8h_source.html +++ b/docs/librishka_8h_source.html @@ -129,7 +129,7 @@
44#include <librishka/int.h>
45#include <librishka/io.h>
46#include <librishka/memory.h>
-
47#include <librishka/runtime.h>
+
47#include <librishka/runtime.h>
48#include <librishka/spi.h>
49#include <librishka/sys.h>
50#include <librishka/types.h>
@@ -141,6 +141,7 @@
int.h
Header file for interrupt handling in Rishka applications.
io.h
Header file for input/output operations in Rishka applications.
memory.h
Header file for memory management in Rishka applications.
+
runtime.h
Provides utilities for managing runtime operations within Rishka applications.
spi.h
Header file for SPI (Serial Peripheral Interface) communication in Rishka applications.
sys.h
Header file for system utilities in Rishka applications.
types.h
Header file for common data types used in Rishka applications.
diff --git a/docs/navtreeindex0.js b/docs/navtreeindex0.js index 55d099b..0c498df 100644 --- a/docs/navtreeindex0.js +++ b/docs/navtreeindex0.js @@ -76,6 +76,7 @@ var NAVTREEINDEX0 = "memory_8h.html":[4,0,0,0,6], "memory_8h_source.html":[4,0,0,0,6], "pages.html":[], +"runtime_8h.html":[4,0,0,0,7], "runtime_8h_source.html":[4,0,0,0,7], "spi_8h.html":[4,0,0,0,8], "spi_8h.html#ac4b206a51636d91c5cffcbcee458c3cb":[4,0,0,0,8,1], diff --git a/docs/runtime_8h.html b/docs/runtime_8h.html new file mode 100644 index 0000000..a2eab58 --- /dev/null +++ b/docs/runtime_8h.html @@ -0,0 +1,124 @@ + + + + + + + +Rishka: sdk/librishka/runtime.h File Reference + + + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Rishka +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes
+
runtime.h File Reference
+
+
+ +

Provides utilities for managing runtime operations within Rishka applications. +More...

+ +

Go to the source code of this file.

+ + + + + +

+Classes

class  Runtime
 The Runtime class provides utilities for managing runtime operations. More...
 
+

Detailed Description

+

Provides utilities for managing runtime operations within Rishka applications.

+
Author
Nathanne Isip
+

The Runtime class encapsulates functionality related to runtime management and control flow within Rishka applications. It serves as a central hub for coordinating runtime activities, such as task scheduling, event processing, and resource management. Developers can leverage the Runtime class to orchestrate the execution flow of their applications, ensuring efficient utilization of system resources and optimal performance.

+
+
+ \ No newline at end of file diff --git a/docs/runtime_8h.js b/docs/runtime_8h.js new file mode 100644 index 0000000..47ef4d8 --- /dev/null +++ b/docs/runtime_8h.js @@ -0,0 +1,4 @@ +var runtime_8h = +[ + [ "Runtime", "class_runtime.html", null ] +]; \ No newline at end of file diff --git a/docs/runtime_8h_source.html b/docs/runtime_8h_source.html index 27aaa10..aea0f91 100644 --- a/docs/runtime_8h_source.html +++ b/docs/runtime_8h_source.html @@ -102,7 +102,7 @@
runtime.h
-
1/*
+Go to the documentation of this file.
1/*
2 * This file is part of the Rishka distribution (https://github.com/rishka-esp32/rishka-sdk).
3 * Copyright (c) 2024 Nathanne Isip.
4 *
@@ -119,18 +119,18 @@
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
-
18#ifndef LIBRISHKA_RUNTIME_H
-
19#define LIBRISHKA_RUNTIME_H
-
20
-
-
29class Runtime final {
-
30public:
-
42 static void yield();
-
43};
+
31#ifndef LIBRISHKA_RUNTIME_H
+
32#define LIBRISHKA_RUNTIME_H
+
33
+
+
42class Runtime final {
+
43public:
+
55 static void yield();
+
56};
-
44
-
45#endif /* LIBRISHKA_RUNTIME_H */
-
Runtime
The Runtime class provides utilities for managing runtime operations.
Definition runtime.h:29
+
57
+
58#endif /* LIBRISHKA_RUNTIME_H */
+
Runtime
The Runtime class provides utilities for managing runtime operations.
Definition runtime.h:42
Runtime::yield
static void yield()
Yield the execution context to other tasks or threads.
Definition librishka_impl.cpp:655
diff --git a/docs/search/all_e.js b/docs/search/all_e.js index e741057..36ec3a4 100644 --- a/docs/search/all_e.js +++ b/docs/search/all_e.js @@ -14,5 +14,6 @@ var searchData= ['rmdir_11',['rmdir',['../class_f_s.html#a24f4d7fe44e698f6467ce673be778de5',1,'FS']]], ['rune_12',['rune',['../types_8h.html#a405b10d09d9298aac12e28a2e92c4641',1,'types.h']]], ['runtime_13',['Runtime',['../class_runtime.html',1,'']]], - ['runtime_20system_20calls_14',['Runtime System Calls',['../group__syscalls.html',1,'Runtime System Calls'],['../syscalls.html',1,'Runtime System Calls']]] + ['runtime_20system_20calls_14',['Runtime System Calls',['../group__syscalls.html',1,'Runtime System Calls'],['../syscalls.html',1,'Runtime System Calls']]], + ['runtime_2eh_15',['runtime.h',['../runtime_8h.html',1,'']]] ]; diff --git a/docs/search/files_6.js b/docs/search/files_6.js index b3a188f..c1ef467 100644 --- a/docs/search/files_6.js +++ b/docs/search/files_6.js @@ -1,5 +1,4 @@ var searchData= [ - ['spi_2eh_0',['spi.h',['../spi_8h.html',1,'']]], - ['sys_2eh_1',['sys.h',['../sys_8h.html',1,'']]] + ['runtime_2eh_0',['runtime.h',['../runtime_8h.html',1,'']]] ]; diff --git a/docs/search/files_7.js b/docs/search/files_7.js index f4d8923..b3a188f 100644 --- a/docs/search/files_7.js +++ b/docs/search/files_7.js @@ -1,4 +1,5 @@ var searchData= [ - ['types_2eh_0',['types.h',['../types_8h.html',1,'']]] + ['spi_2eh_0',['spi.h',['../spi_8h.html',1,'']]], + ['sys_2eh_1',['sys.h',['../sys_8h.html',1,'']]] ]; diff --git a/docs/search/files_8.js b/docs/search/files_8.js new file mode 100644 index 0000000..f4d8923 --- /dev/null +++ b/docs/search/files_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['types_2eh_0',['types.h',['../types_8h.html',1,'']]] +]; diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js index 8699757..0e2ce93 100644 --- a/docs/search/searchdata.js +++ b/docs/search/searchdata.js @@ -2,7 +2,7 @@ var indexSectionsWithContent = { 0: "abcdefghilmnoprstuvwy", 1: "afgimrs", - 2: "afgilmst", + 2: "afgilmrst", 3: "abcdefgilmnoprstvwy", 4: "airsu", 5: "gis", diff --git a/sdk/librishka/runtime.h b/sdk/librishka/runtime.h index 98079d6..f2059b3 100644 --- a/sdk/librishka/runtime.h +++ b/sdk/librishka/runtime.h @@ -15,6 +15,19 @@ * along with this program. If not, see . */ +/** + * @file runtime.h + * @author [Nathanne Isip](https://github.com/nthnn) + * @brief Provides utilities for managing runtime operations within Rishka applications. + * + * The Runtime class encapsulates functionality related to runtime management + * and control flow within Rishka applications. It serves as a central hub for + * coordinating runtime activities, such as task scheduling, event processing, + * and resource management. Developers can leverage the Runtime class to + * orchestrate the execution flow of their applications, ensuring efficient + * utilization of system resources and optimal performance. + */ + #ifndef LIBRISHKA_RUNTIME_H #define LIBRISHKA_RUNTIME_H