Update DelegateMQ library

Author: endurodave

DelegateMQ/delegate/DelegateOpt.h

@@ -11,6 +11,7 @@ namespace dmq
     using Duration = std::chrono::duration<uint32_t, std::milli>;
 }
 
+// @TODO: Select the desired software fault handling (see Predef.cmake).
 #ifdef DMQ_ASSERTS
     #include <cassert>
     // Use assert error handling. Change assert to a different error 
@@ -22,6 +23,7 @@ namespace dmq
     #define BAD_ALLOC() throw std::bad_alloc()
 #endif
 
+// @TODO: Select the desired heap allocation (see Predef.cmake).
 // If DMQ_ASSERTS defined above, consider defining DMQ_ALLOCATOR to prevent 
 // std::list usage within delegate library from throwing a std::bad_alloc 
 // exception. The std_allocator calls assert if out of memory. 
@@ -46,6 +48,7 @@ namespace dmq
     #define XALLOCATOR
 #endif
 
+// @TODO: Select the desired logging (see Predef.cmake).
 #ifdef DMQ_LOG
     #include <spdlog/spdlog.h>
     #define LOG_INFO(...)    spdlog::info(__VA_ARGS__)

DelegateMQ/delegate/IDispatcher.h

@@ -13,6 +13,7 @@ typedef uint16_t DelegateRemoteId;
 const uint16_t INVALID_REMOTE_ID = -1;
 const uint16_t ACK_REMOTE_ID = 0;
 
+/// @TODO Implement the IDispatcher interface if necessary.
 /// @brief Delegate interface class to dispatch serialized function argument data
 /// to a remote destination. Implemented by the application if using remote delegates.
 /// 

DelegateMQ/delegate/ISerializer.h

@@ -11,6 +11,7 @@ namespace dmq {
 template <class R>
 struct ISerializer; // Not defined
 
+/// @TODO Implement the ISerializer interface if necessary.
 /// @brief Delegate serializer interface for serializing and deserializing
 /// remote delegate arguments. Implemented by application code if remote 
 /// delegates are used.

DelegateMQ/delegate/IThread.h

@@ -5,7 +5,7 @@
 
 namespace dmq {
 
-/// @file
+/// @TODO Implement the IThread interface if necessary.
 /// @brief A base class for a delegate enabled execution thread. Implemented by 
 /// application code if asynchronous delegates are used. 
 /// 

DelegateMQ/predef/os/freertos/Thread.cpp

@@ -99,6 +99,8 @@ void Thread::Process(void* instance)
 			{
 				case MSG_DISPATCH_DELEGATE:
 				{
+					// @TODO: Update error handling below if necessary.
+					
 					// Get pointer to DelegateMsg data from queue msg data
 					auto delegateMsg = msg->GetData();
 					ASSERT_TRUE(delegateMsg);

DelegateMQ/predef/os/freertos/Thread.h

@@ -16,7 +16,7 @@
 /// @TODO: Implement a priority queue for the thread messages like 
 /// std::priority_queue<ThreadMsg*, std::vector<ThreadMsg*>, ThreadMsgComparator>
 /// as implemented in stdlib\Thread.h if necessary.
-/// Optionally implement a watchdog mechanism as shown in stdlib\Thread.h.
+/// @TODO: Optionally implement a watchdog mechanism as shown in stdlib\Thread.h.
 
 class ThreadMsg;
 

DelegateMQ/predef/os/stdlib/Thread.cpp

@@ -34,7 +34,9 @@ bool Thread::CreateThread(std::optional<dmq::Duration> watchdogTimeout)
 {
 	if (!m_thread)
 	{
+		m_threadStartPromise = std::promise<void>();
 		m_threadStartFuture = m_threadStartPromise.get_future();
+		m_exit = false;
 
 		m_thread = std::unique_ptr<std::thread>(new thread(&Thread::Process, this));
 
@@ -140,11 +142,24 @@ void Thread::ExitThread()
 	m_exit.store(true);
     m_thread->join();
 
-	// Clear the queue if anything added while waiting for join
+	// Prevent deadlock if ExitThread is called from within the thread itself
+	if (m_thread->joinable())
+	{
+		if (std::this_thread::get_id() != m_thread->get_id())
+		{
+			m_thread->join();
+		}
+		else
+		{
+			// We are killing ourselves. Detach so the thread object cleans up naturally.
+			m_thread->detach();
+		}
+	}
+
 	{
 		lock_guard<mutex> lock(m_mutex);
 		m_thread = nullptr;
-		while (!m_queue.empty()) 
+		while (!m_queue.empty())
 			m_queue.pop();
 	}
 
@@ -189,7 +204,7 @@ void Thread::WatchdogCheck()
 	{
 		LOG_ERROR("Watchdog detected unresponsive thread: {}", THREAD_NAME);
 
-		// @TODO You can optionally trigger recovery, restart, or further actions here
+		// @TODO Optionally trigger recovery, restart, or further actions here
 		// For example, throw or notify external system
 	}
 }
@@ -235,6 +250,8 @@ void Thread::Process()
 		{
 			case MSG_DISPATCH_DELEGATE:
 			{
+				// @TODO: Update error handling below if necessary.
+				
 				// Get pointer to DelegateMsg data from queue msg data
 				auto delegateMsg = msg->GetData();
 				ASSERT_TRUE(delegateMsg);

DelegateMQ/predef/transport/ITransport.h

@@ -4,6 +4,7 @@
 #include "DmqHeader.h"
 #include "../../delegate/DelegateOpt.h"
 
+/// @TODO Implement the ITransport interface if necessary.
 /// @brief DelegateMQ transport interface. 
 class ITransport
 {

DelegateMQ/predef/transport/ITransportMonitor.h

@@ -4,6 +4,7 @@
 //#include "DmqHeader.h"
 //#include <sstream>
 
+/// @TODO Implement the ITransportMonitor interface if necessary.
 /// @brief DelegateMQ transport monitor interface. 
 class ITransportMonitor
 {

DelegateMQ/predef/transport/nng/NngTransport.h

@@ -235,7 +235,7 @@ class NngTransport : public ITransport
 
         if (header.GetMarker() != DmqHeader::MARKER) {
             std::cerr << "Invalid sync marker!" << std::endl;
-            return -1;  // TODO: Optionally handle this case more gracefully
+            return -1;  // @TODO: Optionally handle this case more gracefully
         }
 
         // Read the DelegateRemoteId (2 bytes) into the `id` variable