C

Qul::Platform::MessageQueueInterface Class

class Qul::Platform::MessageQueueInterface

Qt Quick Ultralite 向けに、プラットフォーム固有のキューを提供するインターフェースクラス。詳細...

Header:	`#include <platform/messagequeue.h>`
Since:	Qt Quick Ultralite (Platform) 1.9

継承されたメンバーを含む、すべてのメンバーの一覧

パブリック関数

`(since Qt Quick Ultralite (Platform) 1.9)` virtual	~MessageQueueInterface()
`(since Qt Quick Ultralite (Platform) 1.9)` virtual uint32_t	capacity() const = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual void	clearOverrun() = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual bool	discardSupported() const = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual Qul::Platform::MessageQueueStatus	enqueueOrDiscard(const void *message) = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual Qul::Platform::MessageQueueStatus	enqueueOrDiscardFromInterrupt(const void *message)
`(since Qt Quick Ultralite (Platform) 1.9)` virtual Qul::Platform::MessageQueueStatus	enqueueOrOverwrite(const void *message) = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual Qul::Platform::MessageQueueStatus	enqueueOrOverwriteFromInterrupt(const void *message)
`(since Qt Quick Ultralite (Platform) 1.9)` virtual bool	isEmpty() const = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual bool	isEmptyFromInterrupt() const
`(since Qt Quick Ultralite (Platform) 1.9)` virtual bool	isOverrun() const = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual bool	overwriteSupported() const = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual Qul::Platform::MessageQueueStatus	receive(void *message, int32_t timeout = 0) = 0
`(since Qt Quick Ultralite (Platform) 1.9)` virtual Qul::Platform::MessageQueueStatus	receiveFromInterrupt(void *message, int32_t timeout = 0)

プロテクトされた関数

(since Qt Quick Ultralite (Platform) 1.9) MessageQueueInterface()

詳細な説明

Qt Quick Ultralite は、このインターフェースを使用してEventQueues のキューを実装します。これは、独自のキュー実装（または OS が提供する実装）があり、Qt Quick Ultralite が提供するデフォルトの実装よりもそれを優先したい場合に役立ちます。

デフォルトでは、enqueueOrDiscardFromInterrupt()、enqueueOrOverwriteFromInterrupt()、およびreceiveFromInterrupt() は、それぞれ対応する非割り込みバージョンを呼び出します。基盤となるキュー機能が割り込みセーフであるか、割り込みセーフ性を確保するための措置が講じられている場合を除き、これらをオーバーライドする必要があります。

破棄および/または上書きのサポートは、discardSupported() およびoverwriteSupported() 関数からブール値を返すことで示されます。

注： EventQueue が期待どおりに機能するためには、これらの操作のうち少なくとも一方 、あるいは両方がサポートされている必要があります。

例

MessageQueueInterface は、単純な循環バッファを使用して実装されています。

このキューの実装は上書きをサポートしていないため、キューにプッシュできないメッセージはすべて破棄されます。

サブクラスは次のようなものになります。

class MyMessageQueue : public MessageQueueInterface
{
public:
    MyMessageQueue(const uint32_t &capacity, const uint32_t &messageSize)
        : MessageQueueInterface()
        , mQueue(NULL)
        , mOverrunFlag(false)
    {
        void *memory = qul_malloc(sizeof(Private::CircularBuffer));
        mQueue = new (memory) Private::CircularBuffer(capacity, messageSize);
    }

    ~MyMessageQueue()
    {
        mQueue->~CircularBuffer();
        qul_free(mQueue);
    }

    MessageQueueStatus enqueueOrDiscard(const void *message) QUL_DECL_OVERRIDE
    {
        if (mQueue->isFull()) {
            // Discard message
            mOverrunFlag = true;
            return MessageQueueStatus::MessageDiscarded;
        }

        mQueue->pushBack(message);
        return MessageQueueStatus::Success;
    }

    MessageQueueStatus enqueueOrDiscardFromInterrupt(const void *message) QUL_DECL_OVERRIDE
    {
        // disableInterrupts();
        MessageQueueStatus state = enqueueOrDiscard(message);
        // enableInterrupts();
        return state;
    }

    MessageQueueStatus enqueueOrOverwrite(const void *message) QUL_DECL_OVERRIDE
    {
        return MessageQueueStatus::OverwriteNotSupported;
    }

    MessageQueueStatus receive(void *message, int32_t timeout = 0) QUL_DECL_OVERRIDE
    {
        (void) timeout; // This example does not implement timeout handling.

        if (mQueue->isEmpty())
            return MessageQueueStatus::EmptyQueue;

        mQueue->popFront(message);
        return MessageQueueStatus::Success;
    }

    MessageQueueStatus receiveFromInterrupt(void *message, int32_t timeout = 0) QUL_DECL_OVERRIDE
    {
        (void) timeout; // This example does not implement timeout handling.

        // disableInterrupts();
        MessageQueueStatus state = receive(message);
        // enableInterrupts();
        return state;
    }

    bool discardSupported() const QUL_DECL_OVERRIDE { return true; }
    bool overwriteSupported() const QUL_DECL_OVERRIDE { return false; }

    bool isEmpty() const QUL_DECL_OVERRIDE { return mQueue->isEmpty(); }
    bool isEmptyFromInterrupt() const QUL_DECL_OVERRIDE
    {
        // disableInterrupts();
        return isEmpty();
        // enableInterrupts();
    }

    bool isOverrun() const QUL_DECL_OVERRIDE { return mOverrunFlag; }

    void clearOverrun() QUL_DECL_OVERRIDE { mOverrunFlag = false; }

    uint32_t capacity() const QUL_DECL_OVERRIDE { return mQueue->capacity(); }

private:
    Private::CircularBuffer *mQueue;
    bool mOverrunFlag;
};

その後、Qul::Platform::requestQueue() 関数を実装します。

MessageQueueInterface *requestQueue(size_t queueCapacity, size_t messageSize)
{
    void *queue = qul_malloc(sizeof(MyMessageQueue));

    if (queue == NULL) {
        return NULL;
    }

    MessageQueueInterface *interface = new (queue) MyMessageQueue(queueCapacity, messageSize);
    return interface;
}

さらに、Qul::Platform::deleteQueue() 関数を実装してください:

void deleteQueue(MessageQueueInterface *queue)
{
    MyMessageQueue *mq = static_cast<MyMessageQueue *>(queue);
    mq->~MyMessageQueue();
    qul_free(mq);
}

最後に、Qul::Platform::maxQueueMessageSize() を実装します：

size_t maximumQueueMessageSize()
{
    return LONG_MAX;
}

Qul::Platform::MessageQueue およびQul::EventQueueも参照してください。