From 7a4a1af3322daf380b1f35f2d9eb2e687eb6219a Mon Sep 17 00:00:00 2001
From: Girts Folkmanis <girtsf@users.noreply.github.com>
Date: Sun, 15 Mar 2020 17:52:01 -0700
Subject: [PATCH] TypedQueue: make functions return bools instead of BaseType_t

Minor cleanup to hide away some FreeRTOS bits.

Note: I believe src/CustomRF95.cpp:62 had a bug where it had the
condition inverted.
---
 src/CustomRF95.cpp  |  5 ++---
 src/MemoryPool.h    |  6 ++----
 src/MeshService.cpp |  2 +-
 src/PointerQueue.h  |  4 ++--
 src/TypedQueue.h    | 30 ++++++++++++++++--------------
 5 files changed, 23 insertions(+), 24 deletions(-)

diff --git a/src/CustomRF95.cpp b/src/CustomRF95.cpp
index 9bce33f3..57e094e9 100644
--- a/src/CustomRF95.cpp
+++ b/src/CustomRF95.cpp
@@ -126,8 +126,7 @@ void CustomRF95::handleInterrupt()
                 // parsing was successful, queue for our recipient
                 mp->has_payload = true;
 
-                int res = rxDest.enqueueFromISR(mp, &higherPriWoken); // NOWAIT - fixme, if queue is full, delete older messages
-                assert(res == pdTRUE);
+                assert(rxDest.enqueueFromISR(mp, &higherPriWoken)); // NOWAIT - fixme, if queue is full, delete older messages
             }
 
             clearRxBuf(); // This message accepted and cleared
@@ -185,4 +184,4 @@ void CustomRF95::startSend(MeshPacket *txp)
 
     int res = RH_RF95::send(radiobuf, numbytes);
     assert(res);
-}
\ No newline at end of file
+}
diff --git a/src/MemoryPool.h b/src/MemoryPool.h
index 7b2b6514..2997d26d 100644
--- a/src/MemoryPool.h
+++ b/src/MemoryPool.h
@@ -66,16 +66,14 @@ public:
     /// Return a buffer for use by others
     void release(T *p)
     {
-        int res = dead.enqueue(p, 0);
-        assert(res == pdTRUE);
+        assert(dead.enqueue(p, 0));
         assert(p >= buf && (p - buf) < maxElements); // sanity check to make sure a programmer didn't free something that didn't come from this pool
     }
 
     /// Return a buffer from an ISR, if higherPriWoken is set to true you have some work to do ;-)
     void releaseFromISR(T *p, BaseType_t *higherPriWoken)
     {
-        int res = dead.enqueueFromISR(p, higherPriWoken);
-        assert(res == pdTRUE);
+        assert(dead.enqueueFromISR(p, higherPriWoken));
         assert(p >= buf && (p - buf) < maxElements); // sanity check to make sure a programmer didn't free something that didn't come from this pool
     }
 };
diff --git a/src/MeshService.cpp b/src/MeshService.cpp
index a09b8018..2662b618 100644
--- a/src/MeshService.cpp
+++ b/src/MeshService.cpp
@@ -173,7 +173,7 @@ void MeshService::handleFromRadio(MeshPacket *mp)
             if (d)
                 releaseToPool(d);
         }
-        assert(toPhoneQueue.enqueue(mp, 0) == pdTRUE); // FIXME, instead of failing for full queue, delete the oldest mssages
+        assert(toPhoneQueue.enqueue(mp, 0)); // FIXME, instead of failing for full queue, delete the oldest mssages
 
         if (mp->payload.want_response)
             sendNetworkPing(mp->from);
diff --git a/src/PointerQueue.h b/src/PointerQueue.h
index 884e523c..5dc57bd5 100644
--- a/src/PointerQueue.h
+++ b/src/PointerQueue.h
@@ -18,7 +18,7 @@ public:
     {
         T *p;
 
-        return this->dequeue(&p, maxWait) == pdTRUE ? p : NULL;
+        return this->dequeue(&p, maxWait) ? p : nullptr;
     }
 
     // returns a ptr or null if the queue was empty
@@ -26,6 +26,6 @@ public:
     {
         T *p;
 
-        return this->dequeueFromISR(&p, higherPriWoken) == pdTRUE ? p : NULL;
+        return this->dequeueFromISR(&p, higherPriWoken) ? p : nullptr;
     }
 };
diff --git a/src/TypedQueue.h b/src/TypedQueue.h
index 36f07fab..57c51eac 100644
--- a/src/TypedQueue.h
+++ b/src/TypedQueue.h
@@ -1,18 +1,22 @@
 #pragma once
 
-#include <Arduino.h>
-#include <assert.h>
+#include <cassert>
+#include <type_traits>
+
+#include <freertos/FreeRTOS.h>
+#include <freertos/queue.h>
 
 /**
- * A wrapper for freertos queues.  Note: each element object must be quite small, so T should be only
- * pointer types or ints
+ * A wrapper for freertos queues.  Note: each element object should be small
+ * and POD (Plain Old Data type) as elements are memcpied by value.
  */
 template <class T>
 class TypedQueue
 {
+    static_assert(std::is_pod<T>::value, "T must be pod");
     QueueHandle_t h;
 
-public:
+  public:
     TypedQueue(int maxElements)
     {
         h = xQueueCreate(maxElements, sizeof(T));
@@ -34,24 +38,22 @@ public:
         return uxQueueMessagesWaiting(h) == 0;
     }
 
-    // pdTRUE for success else failure
-    BaseType_t enqueue(T x, TickType_t maxWait = portMAX_DELAY)
+    bool enqueue(T x, TickType_t maxWait = portMAX_DELAY)
     {
-        return xQueueSendToBack(h, &x, maxWait);
+        return xQueueSendToBack(h, &x, maxWait) == pdTRUE;
     }
 
-    BaseType_t enqueueFromISR(T x, BaseType_t *higherPriWoken)
+    bool enqueueFromISR(T x, BaseType_t *higherPriWoken)
     {
-        return xQueueSendToBackFromISR(h, &x, higherPriWoken);
+        return xQueueSendToBackFromISR(h, &x, higherPriWoken) == pdTRUE;
     }
 
-    // pdTRUE for success else failure
-    BaseType_t dequeue(T *p, TickType_t maxWait = portMAX_DELAY)
+    bool dequeue(T *p, TickType_t maxWait = portMAX_DELAY)
     {
-        return xQueueReceive(h, p, maxWait);
+        return xQueueReceive(h, p, maxWait) == pdTRUE;
     }
 
-    BaseType_t dequeueFromISR(T *p, BaseType_t *higherPriWoken)
+    bool dequeueFromISR(T *p, BaseType_t *higherPriWoken)
     {
         return xQueueReceiveFromISR(h, p, higherPriWoken);
     }