CommandsQueue.h

Go to the documentation of this file.

// $Id: CommandsQueue.h 4464 2020-04-15 12:14:20Z linev $
 
/************************************************************
 * The Data Acquisition Backbone Core (DABC)                *
 ************************************************************
 * Copyright (C) 2009 -                                     *
 * GSI Helmholtzzentrum fuer Schwerionenforschung GmbH      *
 * Planckstr. 1, 64291 Darmstadt, Germany                   *
 * Contact:  http://dabc.gsi.de                             *
 ************************************************************
 * This software can be used under the GPL license          *
 * agreements as stated in LICENSE.txt file                 *
 * which is part of the distribution.                       *
 ************************************************************/
 
#ifndef DABC_CommandsQueue
#define DABC_CommandsQueue
 
#ifndef DABC_Command
#include "dabc/Command.h"
#endif
 
#include <list>
 
#include <cstdint>
 
namespace dabc {
 
   class Worker;
 
   class CommandsQueue {
 
      public:
 
         enum EKind {
            kindNone,
            kindSubmit,    
            kindReply,     
            kindAssign,    
            kindPostponed  
         };
 
      protected:
 
         struct QueueRec {
            Command     cmd;
            EKind       kind;
            uint32_t    id;
 
            QueueRec() : cmd(), kind(kindNone), id(0) {}
            QueueRec(const Command& _cmd, EKind _kind, uint32_t _id) : cmd(_cmd), kind(_kind), id(_id) {}
            QueueRec(const QueueRec& src) : cmd(src.cmd), kind(src.kind), id(src.id) {}
            QueueRec& operator=(const QueueRec& src)
            {
               cmd = src.cmd;
               kind = src.kind;
               id = src.id;
               return *this;
            }
         };
 
         typedef std::list<QueueRec> QueueRecsList;
 
         QueueRecsList     fList;
         EKind             fKind;
         uint32_t          fIdCounter;
 
      public:
         CommandsQueue(EKind kind = kindNone);
         virtual ~CommandsQueue();
 
         uint32_t Push(Command cmd, EKind kind = kindNone);
 
         uint32_t ChangeKind(Command& cmd, EKind kind);
 
         Command  Pop();
         Command  PopWithId(uint32_t id);
         Command  PopWithKind(EKind kind);
         Command  Front();
         EKind    FrontKind();
 
         unsigned Size() const { return fList.size(); }
 
         void ReplyAll(int res);
 
         void ReplyTimedout();
 
         void Cleanup(Mutex *m = nullptr, Worker *proc = nullptr, int res = cmd_false);
   };
 
}
 
#endif