meshx_task.c File Reference

Implementation of MeshX task management functions using FreeRTOS. This file provides APIs to create, delete, suspend, resume, and delay tasks in the MeshX framework. More...

#include "interface/rtos/meshx_task.h"
#include "freertos/FreeRTOS.h"
#include "freertos/portmacro.h"
#include "freertos/task.h"
#include "esp_system.h"

Include dependency graph for meshx_task.c:

Go to the source code of this file.

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

Implementation of MeshX task management functions using FreeRTOS. This file provides APIs to create, delete, suspend, resume, and delay tasks in the MeshX framework.

Copyright (c) 2024 - 2025 MeshX

Author

Pranjal Chanda

Definition in file meshx_task.c.

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;
}