Managing the app worker.
This modules contains functions for and managing the worker task, querying its status, and communicating with it
bool app_worker_is_running |
( |
void |
) | |
|
Determine if the worker for the current app is running.
- Returns
- true if running
Kill the worker for the current app. Note that this is an asynchronous operation, a result code of APP_WORKER_RESULT_SUCCESS merely means that the request was successfully queued up.
- Returns
- result code
Launch the worker for the current app. Note that this is an asynchronous operation, a result code of APP_WORKER_RESULT_SUCCESS merely means that the request was successfully queued up.
- Returns
- result code
Subscribe to worker messages. Once subscribed, the handler gets called on every message emitted by the other task (either worker or app).
- Parameters
-
handler | A callback to be executed when the event is received |
- Returns
- true on success
bool app_worker_message_unsubscribe |
( |
void |
) | |
|
Unsubscribe from worker messages. Once unsubscribed, the previously registered handler will no longer be called.
- Returns
- true on success
Send a message to the other task (either worker or app).
- Parameters
-
type | An application defined message type |
data | the message data structure |
Generic structure of a worker message that can be sent between an app and its worker.
Callback type for worker messages. Messages can be sent from worker to app or vice versa.
- Parameters
-
type | An application defined message type |
data | pointer to message data. The receiver must know the structure of the data provided by the sender. |
Possible error codes from app_worker_launch, app_worker_kill.
Enumerator |
---|
APP_WORKER_RESULT_SUCCESS |
Success.
|
APP_WORKER_RESULT_NO_WORKER |
No worker found for the current app.
|
APP_WORKER_RESULT_DIFFERENT_APP |
A worker for a different app is already running.
|
APP_WORKER_RESULT_NOT_RUNNING |
The worker is not running.
|
APP_WORKER_RESULT_ALREADY_RUNNING |
The worker is already running.
|
APP_WORKER_RESULT_ASKING_CONFIRMATION |
The user will be asked for confirmation.
|