AbstractMsgQueue.h

Go to the documentation of this file.

// Copyright CERN 2012 - Developed in collaboration with GSI

#ifndef ABSTRACT_MSG_QUEUE_H_
#define ABSTRACT_MSG_QUEUE_H_

#include <fesa-core/Core/AbstractEquipment.h>
#include <fesa-core/Utilities/ProcessConfiguration.h>

namespace fesa
{

class AbstractMessage;

typedef enum
{
    LOCAL_MSG_QUEUE, IPC_MSG_QUEUE
} MQ_TYPE;

const uint32_t HIGH_MQ_PRIO = 10;
const uint32_t DEFAULT_MQ_PRIO = 9;
const uint32_t LOW_MQ_PRIO = 8;

class AbstractMsgQueue
{

  public:

    class Constants
    {
      public:

        uint32_t msg_size_max_;

        uint32_t msg_num_max_;

        uint32_t queue_diag_slots;

        Constants()
        {
            const ProcessConfiguration* configuration = AbstractEquipment::getInstance()->getProcessConfiguration();
            msg_size_max_ = configuration->getIntValue(PropertyTag::MSG_SIZE_MAX);
            msg_num_max_ = configuration->getIntValue(PropertyTag::MSG_NUM_MAX);
            queue_diag_slots = configuration->getIntValue(PropertyTag::MSG_DIAG_SLOTS);
        }
    };

    const Constants constants_;

    AbstractMsgQueue(const std::string& name, MQ_TYPE type, uint32_t queueLength);

    virtual ~AbstractMsgQueue();

    virtual uint32_t isFull();

    virtual uint32_t isAlmostFull();

    virtual const std::string& getQueueName();

    virtual uint32_t getQueueLength();

    virtual void postMsg(AbstractMessage* msg) = 0;

    virtual AbstractMessage* consumeMsg() = 0;

    virtual void purge() = 0;

    virtual uint32_t getCurrentMsgCount() = 0;

    virtual void checkState(uint32_t msgPrio);

  protected:

    std::string queueName_;

    MQ_TYPE queueType_;

    const uint32_t queueLength_;

  private:

    AbstractMsgQueue(const AbstractMsgQueue&);

    AbstractMsgQueue& operator=(const AbstractMsgQueue&);
};

inline const std::string& AbstractMsgQueue::getQueueName()
{
    return queueName_;
}

inline uint32_t AbstractMsgQueue::getQueueLength()
{
    return queueLength_;
}

} // fesa

#endif //ABSTRACT_MSG_QUEUE_H_