ThreadSafeQueue.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/
 
#pragma once
 
#include <OnixS/FIXEngine/ABI.h>
#include <OnixS/FIXEngine/Threading/Definitions.h>
 
namespace OnixS {
namespace Threading {
 
struct ThreadSafeQueueResult
{
    enum Enum
    {
        Timeout,

        Data,
 
        // We don't get data but was signaled to stop wait.
        Signaled
    };
};

class ONIXS_FIXENGINE_API ThreadSafeQueue
{
public:

    ThreadSafeQueue();

    ~ThreadSafeQueue();

    void enqueue(ItemBaseUniquePtr & enqueueItem);

    ThreadSafeQueueResult::Enum dequeue(ItemBaseUniquePtr & dequeueItem, const int waitInMs = InfiniteTimeout);

    void clear();

    bool empty() const;

    void signal();
 
private:

    struct Impl;
    Impl * impl_;

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