TimeoutTimer.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/FIX/TimeSpan.h>

namespace OnixS {
namespace FIX {

/// The timeout timer to control the time interval in a loop.
/// It can help to control a time interval during the dispatching in the `ExternalThread` mode.
class ONIXS_FIXENGINE_API TimeoutTimer
{
public:

    /// The constructor.
    ///
    /// @param timeout The timeout that the timer should control.
    explicit TimeoutTimer(const TimeSpan & timeout);

    /// The destructor.
    ~TimeoutTimer();

    /// Returns 'true' if the timeout is elapsed, otherwise - 'false'.
    bool elapsed() const;

private:

    TimeoutTimer(const TimeoutTimer &);
    TimeoutTimer & operator = (const TimeoutTimer &);

    class Impl;
    Impl * const impl_;
};
}
}