AMessageQueue.h

// AUI Framework - Declarative UI toolkit for modern C++20
// Copyright (C) 2020-2025 Alex2772 and Contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
#include <AUI/Thread/AMutex.h>
#include <AUI/Common/ADeque.h>

template<typename Mutex = AMutex, typename... Args>
class AMessageQueue {
public:
   using Message = std::function<void(Args...)>;

   void enqueue(Message message) {
       std::unique_lock lock(mSync);
       mMessages << std::move(message);
   }
   void enqueue(Message message) {…}

   void processMessages(Args... args) {
       // cheap lookahead that does not require mutex lock.
       if (mMessages.empty()) {
           return;
       }
       std::unique_lock lock(mSync);
       while (!mMessages.empty()) {
           {
               auto queue = std::move(mMessages);
               lock.unlock();
               for (auto &message: queue) {
                   message(args...);
               }
           } // destroy queue before mutex lock
 
           // cheap lookahead that does not require mutex lock.
           if (mMessages.empty()) {
               return;
           }
 
           lock.lock();
       }
   }
   void processMessages(Args... args) {…}
 
   [[nodiscard]]
   Mutex& sync() noexcept {
       return mSync;
   }
 
   [[nodiscard]]
   ADeque<Message>& messages() noexcept {
       return mMessages;
   }
 
   [[nodiscard]]
   const Mutex& sync() const noexcept {
       return mSync;
   }
 
   [[nodiscard]]
   const ADeque<Message>& messages() const noexcept {
       return mMessages;
   }
 
private:
   ADeque<Message> mMessages;

   Mutex mSync;
};
class AMessageQueue {…};

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.