meshx_task.h File Reference

MeshX Task Interface. More...

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

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

Typedef Documentation

meshx_task_cb_t

typedef void(* meshx_task_cb_t) (void *arg)

MeshX Task Function.

Parameters

[in]

arg

Task Argument

Returns

None

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

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

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

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

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

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