meshx_task.h File Reference

MeshX Task Interface. More...

#include <stddef.h>
#include "meshx_err.h"

Include dependency graph for meshx_task.h:

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

Go to the source code of this file.

Data Structures
struct	meshx_task
	MeshX Task Structure. More...

Typedefs
typedef void(*	meshx_task_cb_t) (void *arg)
	MeshX Task Function.
typedef struct meshx_task	meshx_task_t
	MeshX Task Structure.

Functions
meshx_err_t	meshx_task_create (meshx_task_t *task_handle)
	Create a MeshX Task.
meshx_err_t	meshx_task_delete (meshx_task_t *task_handle)
	Delete a MeshX Task.
meshx_err_t	meshx_task_suspend (meshx_task_t *task_handle)
	Suspend a MeshX Task.
meshx_err_t	meshx_task_resume (meshx_task_t *task_handle)
	Resume a MeshX Task.
meshx_err_t	meshx_task_get_handle (meshx_task_t *task_handle)
	Get Task Handle.
meshx_err_t	meshx_task_delay (uint32_t delay_ms)
	Delay a MeshX Task.

Detailed Description

MeshX Task Interface.

This file contains the MeshX Task Interface.

Note

This file should not be modified.

Version

1.0

Author

Pranjal Chanda

Definition in file meshx_task.h.

Typedef Documentation

meshx_task_cb_t

typedef void(* meshx_task_cb_t) (void *arg)

MeshX Task Function.

Parameters

[in]

arg

Task Argument

Returns

None

Definition at line 26 of file meshx_task.h.

meshx_task_t

typedef struct meshx_task meshx_task_t

MeshX Task Structure.

Function Documentation

meshx_task_create()

meshx_err_t meshx_task_create

(

meshx_task_t *

task_handle

)

Create a MeshX Task.

This function creates a MeshX Task.

Parameters

[in,out]

task_handle

Task Handle

Returns

meshx_err_t

Definition at line 28 of file meshx_task.c.

{
    if (task_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    TaskHandle_t task_handle_temp = NULL;
    BaseType_t err = xTaskCreate(
        (TaskFunction_t)task_handle->task_cb,
        task_handle->task_name,
        task_handle->stack_size,
        task_handle->arg,
        task_handle->priority,
        &task_handle_temp);
 
    if (err != pdPASS)
    {
        return MESHX_FAIL;
    }
 
    task_handle->__task_handle = task_handle_temp;
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_task_delay()

meshx_err_t meshx_task_delay

(

uint32_t

delay_ms

)

Delay a MeshX Task.

This function delays a MeshX Task.

Parameters

[in]

delay_ms

Delay in milliseconds

Returns

meshx_err_t

Definition at line 139 of file meshx_task.c.

{
    if (delay_ms == 0)
    {
        return MESHX_INVALID_ARG;
    }
 
    vTaskDelay(pdMS_TO_TICKS(delay_ms));
 
    return MESHX_SUCCESS;
}

meshx_task_delete()

meshx_err_t meshx_task_delete

(

meshx_task_t *

task_handle

)

Delete a MeshX Task.

This function deletes a MeshX Task.

Parameters

[in]

task_handle

Task Handle

Definition at line 61 of file meshx_task.c.

{
    if (task_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    vTaskDelete(task_handle->__task_handle);
 
    return MESHX_SUCCESS;
}

meshx_task_get_handle()

meshx_err_t meshx_task_get_handle

(

meshx_task_t *

task_handle

)

Get Task Handle.

This function gets the Task Handle.

Parameters

[in]

task_handle

Task Handle

Returns

meshx_err_t

Definition at line 121 of file meshx_task.c.

{
    if (task_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    return MESHX_SUCCESS;
}

meshx_task_resume()

meshx_err_t meshx_task_resume

(

meshx_task_t *

task_handle

)

Resume a MeshX Task.

This function resumes a MeshX Task.

Parameters

[in]

task_handle

Task Handle

Definition at line 100 of file meshx_task.c.

{
    if (task_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    vTaskResume(task_handle->__task_handle);
 
    return MESHX_SUCCESS;
}

meshx_task_suspend()

meshx_err_t meshx_task_suspend

(

meshx_task_t *

task_handle

)

Suspend a MeshX Task.

This function suspends a MeshX Task.

Parameters

[in]

task_handle

Task Handle

Definition at line 81 of file meshx_task.c.

{
    if (task_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    vTaskSuspend(task_handle->__task_handle);
 
    return MESHX_SUCCESS;
}