Include dependency graph for kaa_client.h:
Go to the source code of this file.
Typedefs | |
| typedef struct kaa_client_t | kaa_client_t |
| typedef void(* | external_process_fn )(void *context) |
Functions | |
| kaa_error_t | kaa_client_create (kaa_client_t **kaa_client, kaa_client_props_t *props) |
| Creates and initializes kaa_client. More... | |
| void | kaa_client_destroy (kaa_client_t *kaa_client) |
| De-initializes and destroys Kaa client. More... | |
| kaa_error_t | kaa_client_start (kaa_client_t *kaa_client, external_process_fn external_process, void *external_process_context, kaa_time_t max_delay) |
| Start Kaa client. More... | |
| kaa_error_t | kaa_client_stop (kaa_client_t *kaa_client) |
| Stop Kaa client. More... | |
| kaa_context_t * | kaa_client_get_context (kaa_client_t *kaa_client) |
| Return pointer to Kaa context. More... | |
Typedef Documentation
| typedef void(* external_process_fn)(void *context) |
Definition at line 41 of file kaa_client.h.
| typedef struct kaa_client_t kaa_client_t |
Definition at line 39 of file kaa_client.h.
Function Documentation
| kaa_error_t kaa_client_create | ( | kaa_client_t ** | kaa_client, |
| kaa_client_props_t * | props | ||
| ) |
Creates and initializes kaa_client.
Create Kaa client, initialize Kaa framework.
- Parameters
-
[in,out] kaa_client Pointer to return the address of initialized Kaa client. [in] props Kaa client properties
- Returns
- Error code.
| void kaa_client_destroy | ( | kaa_client_t * | kaa_client | ) |
De-initializes and destroys Kaa client.
After a successful call kaa_client pointer becomes invalid.
- Parameters
-
[in] kaa_context Pointer to an Kaa client.
- Returns
- Error code.
| kaa_context_t* kaa_client_get_context | ( | kaa_client_t * | kaa_client | ) |
Return pointer to Kaa context.
- Parameters
-
[in] kaa_context Pointer to an Kaa client.
- Returns
- pointer to Kaa context.
| kaa_error_t kaa_client_start | ( | kaa_client_t * | kaa_client, |
| external_process_fn | external_process, | ||
| void * | external_process_context, | ||
| kaa_time_t | max_delay | ||
| ) |
Start Kaa client.
Start Kaa client IO loop.
- Parameters
-
[in] kaa_context Pointer to an Kaa client. [in] external_process Callback function to process something outside a main loop [in] external_process_context Callback function context [in] time_t max_delay Callback delay
- Returns
- Error code.
| kaa_error_t kaa_client_stop | ( | kaa_client_t * | kaa_client | ) |
Stop Kaa client.
Stop Kaa client IO loop.
- Parameters
-
[in] kaa_context Pointer to an Kaa client.
- Returns
- Error code.
