MQAtomic.h

/*
 * Copyright (c) 2015 Pavel Vainerman.
 *
 * This program 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, version 2.1.
 *
 * This program 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 Lesser Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
// --------------------------------------------------------------------------
#ifndef MQAtomic_H_
#define MQAtomic_H_
//--------------------------------------------------------------------------
#include <atomic>
#include <vector>
#include <memory>
#include <mutex>
#include "MessageType.h"
//--------------------------------------------------------------------------
typedef std::shared_ptr<uniset::VoidMessage> VoidMessagePtr;
//--------------------------------------------------------------------------
namespace uniset
{
    class MQAtomic
    {
        public:
            MQAtomic( size_t qsize = 2000 );

            bool push( const VoidMessagePtr& msg ) noexcept;

            VoidMessagePtr top() noexcept;
 
            size_t size() const noexcept;
            bool empty() const noexcept;
 
            // ----- Настройки  -----
            // неявно подразумевается, что всё настраивается до первого использования
            // ----------------------
            void setMaxSizeOfMessageQueue( size_t s );
            size_t getMaxSizeOfMessageQueue() const noexcept;

            enum LostStrategy
            {
                lostOldData, // default
                lostNewData
            };
 
            void setLostStrategy( LostStrategy s ) noexcept;
 
            // ---- Статистика ----
            inline size_t getMaxQueueMessages() const noexcept
            {
                return stMaxQueueMessages;
            }

            inline size_t getCountOfLostMessages() const noexcept
            {
                return stCountOfLostMessages;
            }
 
        protected:
 
            // заполнить всю очередь указанным сообщением
            void mqFill( const VoidMessagePtr& v );
 
            // для возможности тестирования переполнения
            // специально делается такая функция
            void set_wpos( unsigned long pos ) noexcept;
            void set_rpos( unsigned long pos ) noexcept;
 
        private:
 
            typedef std::vector<VoidMessagePtr> MQueue;
 
            MQueue mqueue;
            std::atomic_ulong wpos = { 0 }; // позиция на запись
            std::atomic_ulong rpos = { 0 }; // позиция на чтение
            std::atomic_ulong qpos = { 0 }; // текущая позиция последнего элемента (max position) (реально добавленного в очередь)
 
            LostStrategy lostStrategy = { lostOldData };

            size_t SizeOfMessageQueue = { 2000 };
 
            // статистическая информация
            size_t stMaxQueueMessages = { 0 };    
            size_t stCountOfLostMessages = { 0 };    
    };
    // -------------------------------------------------------------------------
} // end of uniset namespace
//---------------------------------------------------------------------------
#endif
//---------------------------------------------------------------------------