/**************************************************************************
*
* Copyright (c) 2024-2024 Diality Inc. - All Rights Reserved.
*
* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
*
* @file    MsgQueues.h
*
* @author  (last)      Sean
* @date    (last)      30-Jul-2024
*
* @author  (original)  Sean
* @date    (original)  30-Jul-2024
*
***************************************************************************/

#ifndef __MSG_QUEUES_H__
#define __MSG_QUEUES_H__

#include "TDCommon.h"

#include "CommBuffers.h"
#include "MessageSupport.h"

/**
 *  @defgroup MsgQueues MsgQueues
 *  @brief The message queues unit provides queuing services for
 *  incoming CAN messages.
 *
 *  @addtogroup MsgQueues
 *  @{
 */

// ********** public definitions **********

/// Enumeration of message queues.
typedef enum Msg_Queues
{
    MSG_Q_IN = 0,                                       ///< Incoming CAN message queue.
    NUM_OF_MSG_QUEUES                                   ///< Number of message queues.
} MSG_QUEUE_T;

// ********** public function prototypes **********

void initMsgQueues( void );
BOOL addToMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg );
BOOL getFromMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg );
BOOL isMsgQueueEmpty( MSG_QUEUE_T queue );
BOOL isMsgQueueFull( MSG_QUEUE_T queue );
void blankMessage( MESSAGE_T *message );
void blankMessageInWrapper( MESSAGE_WRAPPER_T *message );

/**@}*/

#endif