Queue.hpp

Go to the documentation of this file.

 
#ifndef _Queue_hpp_
#define _Queue_hpp_
 
#include <FpConfig.hpp>
#include <Fw/Obj/ObjBase.hpp>
#include <Fw/Types/Serializable.hpp>
#include <Os/QueueString.hpp>
 
namespace Os {
    // forward declaration for registry
    class QueueRegistry;
 
    class Queue {
        public:
 
            enum QueueStatus {
                QUEUE_OK, 
                QUEUE_NO_MORE_MSGS, 
                QUEUE_UNINITIALIZED, 
                QUEUE_SIZE_MISMATCH, 
                QUEUE_SEND_ERROR, 
                QUEUE_RECEIVE_ERROR, 
                QUEUE_INVALID_PRIORITY, 
                QUEUE_EMPTY_BUFFER, 
                QUEUE_FULL, 
                QUEUE_UNKNOWN_ERROR 
            };
 
            enum QueueBlocking {
                QUEUE_BLOCKING, 
                QUEUE_NONBLOCKING 
            };
 
            Queue();
            virtual ~Queue();
            QueueStatus create(const Fw::StringBase &name, NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize); 
 
            // Send serialized buffers
            QueueStatus send(const Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE priority, QueueBlocking block); 
            QueueStatus receive(Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE &priority, QueueBlocking block); 
 
            // Send raw buffers
            QueueStatus send(const U8* buffer, NATIVE_INT_TYPE size, NATIVE_INT_TYPE priority, QueueBlocking block); 
            QueueStatus receive(U8* buffer, NATIVE_INT_TYPE capacity, NATIVE_INT_TYPE &actualSize, NATIVE_INT_TYPE &priority, QueueBlocking block); 
 
            NATIVE_INT_TYPE getNumMsgs() const; 
            NATIVE_INT_TYPE getMaxMsgs() const; 
            NATIVE_INT_TYPE getQueueSize() const; 
            NATIVE_INT_TYPE getMsgSize() const; 
            const QueueString& getName(); 
            static NATIVE_INT_TYPE getNumQueues(); 
#if FW_QUEUE_REGISTRATION
            static void setQueueRegistry(QueueRegistry* reg); // !< set the queue registry
#endif
 
        protected:
            QueueStatus createInternal(const Fw::StringBase &name, NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize); 
            POINTER_CAST m_handle; 
            QueueString m_name; 
#if FW_QUEUE_REGISTRATION
            static QueueRegistry* s_queueRegistry; 
#endif
            static NATIVE_INT_TYPE s_numQueues; 
 
        private:
            Queue(Queue&); 
            Queue(Queue*); 
    };
 
    class QueueRegistry {
        public:
            virtual void regQueue(Queue* obj)=0; 
            virtual ~QueueRegistry() {}; 
    };
}
 
#endif