Diff: DuerOS-Light-SDK-v1.1.0/duer-os-light/src/mutex/baidu_iot_mutex.h

Revision:

47:9e361da97763

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/DuerOS-Light-SDK-v1.1.0/duer-os-light/src/mutex/baidu_iot_mutex.h	Tue Jul 18 16:54:45 2017 +0800
@@ -0,0 +1,72 @@
+/**
+ * Copyright 2017 Baidu Inc. All Rights Reserved.
+ * Author: Gang Chen (chengang12@baidu.com)
+ * This header file is wrapper for OS mutex
+ *
+ */
+
+#ifndef IOT_BAIDU_BAIDU_IOT_MUTEX_H
+#define IOT_BAIDU_BAIDU_IOT_MUTEX_H
+
+#include <stdbool.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef void *iot_mutex_t;
+
+typedef enum {
+    IOT_MUTEX_OK = 0,       // function completed; no error or event occurred.
+    IOT_MUTEX_TIMEOUT,	    // Failed to lock mutex in specified time
+    IOT_MUTEX_ERROR,
+} iot_mutex_status;
+
+/*
+ * Create mutex
+ *
+ * @Return: the created mutex's pointer
+ */
+iot_mutex_t iot_mutex_create(void);
+
+/*
+ * Lock a mutex
+ *
+ * @param mutex[in]: a pointer point to the mutex
+ * @param timeout_ms[in]: timeout value or 0 in case of no time-out
+ *
+ * @Return: iot_mutex_status
+ */
+iot_mutex_status iot_mutex_lock(iot_mutex_t mutex, uint32_t timeout_ms);
+
+/*
+ * Try to lock a mutex, and return immediately
+ *
+ * @param mutex[in]: a pointer point to the mutex
+ *
+ * @return: true if the mutex was acquired, false otherwise.
+ */
+bool iot_mutex_try_lock(iot_mutex_t mutex);
+
+/*
+ * Unlock a mutex
+ *
+ * @param mutex[in]: a pointer point to the mutex
+ *
+ * @Return: iot_mutex_status
+ */
+iot_mutex_status iot_mutex_unlock(iot_mutex_t mutex);
+
+/*
+ * Destroy the mutex context
+ *
+ * @param mutex[in]: a pointer point to the mutex
+ *
+ * @Return: iot_mutex_status
+ */
+iot_mutex_status iot_mutex_destroy(iot_mutex_t mutex);
+
+#ifdef __cplusplus
+}
+#endif
+#endif // end IOT_BAIDU_BAIDU_IOT_MUTEX_H