meshx_msg_q.h File Reference

MeshX Message Queue Interface. More...

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

Include dependency graph for meshx_msg_q.h:

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

Go to the source code of this file.

Data Structures
struct	meshx_msg_q
	MeshX Message Queue Structure. More...

Typedefs
typedef struct meshx_msg_q	meshx_msg_q_t
	MeshX Message Queue Structure.

Functions
meshx_err_t	meshx_msg_q_create (meshx_msg_q_t *msg_q_handle)
	Create a MeshX Message Queue.
meshx_err_t	meshx_msg_q_delete (meshx_msg_q_t *msg_q_handle)
	Delete a MeshX Message Queue.
meshx_err_t	meshx_msg_q_send (meshx_msg_q_t *msg_q_handle, void const *msg, size_t msg_len, uint32_t delay_ms)
	Send a Message to a MeshX Message Queue Back.
meshx_err_t	meshx_msg_q_send_front (meshx_msg_q_t *msg_q_handle, void const *msg, size_t msg_len, uint32_t delay_ms)
	Send a Message to the front of a MeshX Message Queue.
meshx_err_t	meshx_msg_q_recv (meshx_msg_q_t *msg_q_handle, void *msg, uint32_t delay_ms)
	Receive a Message from a MeshX Message Queue.
meshx_err_t	meshx_msg_q_peek (meshx_msg_q_t *msg_q_handle, void *msg, uint32_t delay_ms)
	Peek a Message from a MeshX Message Queue.

Detailed Description

MeshX Message Queue Interface.

This file contains the MeshX Message Queue Interface.

Author

Pranjal Chanda

Version

1.0

Definition in file meshx_msg_q.h.

Typedef Documentation

meshx_msg_q_t

typedef struct meshx_msg_q meshx_msg_q_t

MeshX Message Queue Structure.

Function Documentation

meshx_msg_q_create()

meshx_err_t meshx_msg_q_create

(

meshx_msg_q_t *

msg_q_handle

)

Create a MeshX Message Queue.

This function creates a MeshX Message Queue.

Parameters

[in,out]

msg_q_handle

Message Queue Handle

Returns

Message Queue Handle

Definition at line 26 of file meshx_msg_q.c.

{
    if (msg_q_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    // Create a FreeRTOS queue
    QueueHandle_t queue = xQueueCreate(msg_q_handle->max_msg_length, msg_q_handle->max_msg_depth);
 
    if (queue == NULL)
    {
        // Failed to create queue
        return MESHX_NO_MEM;
    }
 
    // Store the queue handle in the msg_q_handle
    msg_q_handle->__msg_q_handle = queue;
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_msg_q_delete()

meshx_err_t meshx_msg_q_delete

(

meshx_msg_q_t *

msg_q_handle

)

Delete a MeshX Message Queue.

This function deletes a MeshX Message Queue.

Parameters

[in]

msg_q_handle

Message Queue Handle

Definition at line 55 of file meshx_msg_q.c.

{
    if (msg_q_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    // Delete the FreeRTOS queue
    vQueueDelete((QueueHandle_t)msg_q_handle->__msg_q_handle);
 
    return MESHX_SUCCESS;
}

meshx_msg_q_peek()

meshx_err_t meshx_msg_q_peek	(	meshx_msg_q_t *	msg_q_handle,
		void *	msg,
		uint32_t	delay_ms )

Peek a Message from a MeshX Message Queue.

This function peeks a message from a MeshX Message Queue.

Parameters

[in]	msg_q_handle	Message Queue Handle
[in]	msg	Message
[in]	delay_ms	Delay in milliseconds

Returns

Message Queue Handle

Definition at line 172 of file meshx_msg_q.c.

{
    if (msg_q_handle == NULL || msg == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    BaseType_t ret =  xPortInIsrContext() ? xQueuePeekFromISR(msg_q_handle->__msg_q_handle, msg)
        : xQueuePeek(msg_q_handle->__msg_q_handle, msg, pdMS_TO_TICKS(delay_ms));
 
    if (ret!= pdPASS)
    {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

meshx_msg_q_recv()

meshx_err_t meshx_msg_q_recv	(	meshx_msg_q_t *	msg_q_handle,
		void *	msg,
		uint32_t	delay_ms )

Receive a Message from a MeshX Message Queue.

This function receives a message from a MeshX Message Queue.

Parameters

[in]	msg_q_handle	Message Queue Handle
[in]	msg	Message
[in]	delay_ms	Delay in milliseconds

Returns

Message Queue Handle

Definition at line 142 of file meshx_msg_q.c.

{
    if (msg_q_handle == NULL || msg == NULL)
    {
        return MESHX_INVALID_ARG;
    }
    BaseType_t pxHigherPriorityTaskWoken = pdFALSE;
 
    BaseType_t ret =  xPortInIsrContext() ? xQueueReceiveFromISR(msg_q_handle->__msg_q_handle, msg, &pxHigherPriorityTaskWoken)
        : xQueueReceive(msg_q_handle->__msg_q_handle, msg, pdMS_TO_TICKS(delay_ms));
 
    if (ret!= pdPASS)
    {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_msg_q_send()

meshx_err_t meshx_msg_q_send	(	meshx_msg_q_t *	msg_q_handle,
		void const *	msg,
		size_t	msg_len,
		uint32_t	delay_ms )

Send a Message to a MeshX Message Queue Back.

This function sends a message to a MeshX Message Queue.

Parameters

[in]	msg_q_handle	Message Queue Handle
[in]	msg	Message
[in]	msg_len	Message Length
[in]	delay_ms	Delay in milliseconds

Returns

None

Definition at line 80 of file meshx_msg_q.c.

{
    if (msg_q_handle == NULL || msg == NULL || msg_len == 0)
    {
        return MESHX_INVALID_ARG;
    }
 
    BaseType_t pxHigherPriorityTaskWoken = pdFALSE;
 
    BaseType_t ret =  xPortInIsrContext() ? xQueueSendFromISR(msg_q_handle->__msg_q_handle, msg, &pxHigherPriorityTaskWoken)
        : xQueueSend(msg_q_handle->__msg_q_handle, msg, pdMS_TO_TICKS(delay_ms));
 
    if (ret!= pdPASS)
    {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_msg_q_send_front()

meshx_err_t meshx_msg_q_send_front	(	meshx_msg_q_t *	msg_q_handle,
		void const *	msg,
		size_t	msg_len,
		uint32_t	delay_ms )

Send a Message to the front of a MeshX Message Queue.

This function sends a message to the front of a MeshX Message Queue.

Parameters

[in]	msg_q_handle	Message Queue Handle
[in]	msg	Message
[in]	msg_len	Message Length
[in]	delay_ms	Delay in milliseconds

Returns

None

Definition at line 112 of file meshx_msg_q.c.

{
    if (msg_q_handle == NULL || msg == NULL || msg_len == 0)
    {
        return MESHX_INVALID_ARG;
    }
 
    BaseType_t pxHigherPriorityTaskWoken = pdFALSE;
 
    BaseType_t ret =  xPortInIsrContext() ? xQueueSendToFrontFromISR(msg_q_handle->__msg_q_handle, msg, &pxHigherPriorityTaskWoken)
        : xQueueSendToFront(msg_q_handle->__msg_q_handle, msg, pdMS_TO_TICKS(delay_ms));
 
    if (ret!= pdPASS)
    {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}