KIM HyoengJun
/
mbed_fota_fan_control
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of
mbed_fota
by 
KIM HyoengJun
Diff: ext_fota/MsgQueue.h
- Revision:
- 8:9eec2c246a85
- Parent:
- 1:5cf3a6c969be
--- a/ext_fota/MsgQueue.h Mon Jul 20 09:22:15 2015 +0000
+++ b/ext_fota/MsgQueue.h Thu Aug 20 05:16:55 2015 +0000
@@ -1,6 +1,23 @@
+/**
+ * @file MsgQueue.h
+ * @brief Ble message queue
+ * Copyright 2015 SEVENCORE Co., Ltd.
+ *
+ * @author HyeongJun Kim
+ * @version 1.0.0
+ * @date 2015-08-19
+*/
+
#ifndef MSGQUEUE_H
#define MSGQUEUE_H
-
+/**
+ ****************************************************************************************
+ * @addtogroup ext_fota module
+ * @brief Ble message Queue Class Header.
+ *
+ * @{
+ ****************************************************************************************
+ */
namespace sevencore_fota{
struct Element
@@ -12,12 +29,41 @@
class MsgQueue
{
public:
-
+ /**
+ ****************************************************************************************
+ * @brief Ble message queue constructor
+ ****************************************************************************************
+ */
MsgQueue(int MaxSize = 512);
+ /**
+ ****************************************************************************************
+ * @brief Ble message queue destructor
+ ****************************************************************************************
+ */
~MsgQueue(void);
+ /**
+ ****************************************************************************************
+ * @brief Add message in queue
+ ****************************************************************************************
+ */
void EnQueue(void *vData);
+ /**
+ ****************************************************************************************
+ * @brief Remove message in queue
+ ****************************************************************************************
+ */
void *DeQueue(void);
+ /**
+ ****************************************************************************************
+ * @brief Return queue element count
+ ****************************************************************************************
+ */
int GetElementCount(void);
+ /**
+ ****************************************************************************************
+ * @brief Boolean that queue is empty
+ ****************************************************************************************
+ */
bool IsEmpty(void);
private:
@@ -30,5 +76,7 @@
}//namespace
+/// @} ext_fota module
+
#endif //MSG_QUEUE_H