/**************************************************************************
 *
 *  Copyright (c) 2019-2019 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.c
 *
 *  @date 08-Oct-2019
 *  @author S. Nash
 *
 *  @brief MsgQueues service module.  Provides message queue functionality.
 *
 **************************************************************************/

#include "Common.h"
#include "MsgQueues.h"

// ********** private definitions **********

// ********** private data **********

/*************************************************************************
 * @brief initMsgQueues
 * The initMsgQueues function initializes the MsgQueues module.
 * @details
 * Inputs : none
 * Outputs : none
 * @param none
 * @return none
 *************************************************************************/
void initMsgQueues( void )
{

}

/*************************************************************************
 * @brief addToMsgQueue
 * The addToMsgQueue function adds a message to a given message queue.
 * @details
 * Inputs : none
 * Outputs : none
 * @param queue : the message queue to add to
 * @param msg : a pointer to a message structure to add to the queue
 * @return TRUE if message added to queue, FALSE if could not
 *************************************************************************/
BOOL addToMsgQueue( MSG_QUEUE_T queue, MESSAGE_T *msg )
{
    BOOL result = FALSE;

    return result;
}

/*************************************************************************
 * @brief getFromMsgQueue
 * The getFromMsgQueue function retrieves the next message from a given \n
 * message queue.
 * @details
 * Inputs : none
 * Outputs : none
 * @param queue : the message queue to retrieve from
 * @param msg : a pointer to a message structure to stuff
 * @return TRUE if a message was found to retrieve, FALSE if not
 *************************************************************************/
BOOL getFromMsgQueue( MSG_QUEUE_T queue, MESSAGE_T *msg )
{
    BOOL result = FALSE;

    return result;
}

/*************************************************************************
 * @brief isMsgQueueEmpty
 * The isMsgQueueEmpty function determines whether a given message queue is empty.
 * @details
 * Inputs : none
 * Outputs : none
 * @param queue : the message queue to check
 * @return TRUE if a given message queue is empty, FALSE if not
 *************************************************************************/
BOOL isMsgQueueEmpty( MSG_QUEUE_T queue )
{
    BOOL result = FALSE;

    return result;
}

/*************************************************************************
 * @brief isMsgQueueFull
 * The isMsgQueueFull function determines whether a given message queue is full.
 * @details
 * Inputs : none
 * Outputs : none
 * @param queue : the message queue to check
 * @return TRUE if the given message queue is full, FALSE if not
 *************************************************************************/
BOOL isMsgQueueFull( MSG_QUEUE_T queue )
{
    BOOL result = FALSE;

    return result;
}