TcpRecovery.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 <string>
#include <stdexcept>
 
#include <OnixS/CME/MDH/Watch.h>
#include <OnixS/CME/MDH/messaging/String.h>
#include <OnixS/CME/MDH/messaging/Integral.h>
#include <OnixS/CME/MDH/messaging/StrRef.h>
 
#include <OnixS/CME/MDH/Auxiliary/DeprecatedHeaderWarnings.Disable.h>
#include <OnixS/CME/MDH/String.h>
#include <OnixS/CME/MDH/Integral.h>
#include <OnixS/CME/MDH/Auxiliary/DeprecatedHeaderWarnings.Restore.h>
 
ONIXS_CMEMDH_NAMESPACE_BEGIN

inline void throwZeroTcpRecoveryRequestLimit()
{
    throw std::runtime_error("Maximal number of TCP Recovery requests per second must be greater than zero.");
}

class ONIXS_CMEMDH_LTWT TcpRecoverySettings
{
public:
    enum { DefaultAcquisitionTimeout = 500 };

    enum { DefaultMaxRequests = 15 };
 
    TcpRecoverySettings()
        : username_()
        , password_()
        , acquisitionTimeout_(DefaultAcquisitionTimeout)
        , maxRequests_(DefaultMaxRequests)
        , watch_(&UtcWatch::service())
    {
    }
 
    TcpRecoverySettings(const std::string& username, const std::string& password)
        : username_(username)
        , password_(password)
        , acquisitionTimeout_(DefaultAcquisitionTimeout)
        , maxRequests_(DefaultMaxRequests)
        , watch_(&UtcWatch::service())
    {
    }
 
    ~TcpRecoverySettings() {}

    const std::string& username() const
    {
        return username_;
    }

    TcpRecoverySettings& username(const std::string& username)
    {
        username_ = username;
 
        return *this;
    }

    const std::string& password() const
    {
        return password_;
    }

    TcpRecoverySettings& password(const std::string& password)
    {
        password_ = password;
 
        return *this;
    }

    Messaging::UInt32 acquisitionTimeout() const
    {
        return acquisitionTimeout_;
    }

    TcpRecoverySettings& acquisitionTimeout(Messaging::UInt32 acquisitionTimeout)
    {
        acquisitionTimeout_ = acquisitionTimeout;
 
        return *this;
    }

    Messaging::UInt32 maxRequests() const
    {
        return maxRequests_;
    }

    TcpRecoverySettings& maxRequests(Messaging::UInt32 maxRequests)
    {
        if (0 < maxRequests)
        {
            maxRequests_ = maxRequests;
        }
        else
        {
            throwZeroTcpRecoveryRequestLimit();
        }
 
        return *this;
    }

    WatchService& watch() const
    {
        return *watch_;
    }

    TcpRecoverySettings& watch(WatchService& watch)
    {
        watch_ = &watch;
 
        return *this;
    }
 
    private:
        std::string username_;
        std::string password_;
 
        Messaging::UInt32 acquisitionTimeout_;
 
        Messaging::UInt32 maxRequests_;
 
        WatchService* watch_;
};

ONIXS_CMEMDH_EXPORTED
void toStr(std::string&, const TcpRecoverySettings&);

inline std::string toStr(const TcpRecoverySettings& settings)
{
    std::string str;
 
    toStr(str, settings);
 
    return str;
}
 
// A bit of declarations.
ONIXS_CMEMDH_EXPORTED_CLASS_DECL(Handler);

class ONIXS_CMEMDH_EXPORTED TcpRecoveryService
{
public:
    TcpRecoveryService(const TcpRecoverySettings&);

    virtual ~TcpRecoveryService();

    virtual void brief(std::string&);

    virtual bool tryAcquire(const Handler&, Messaging::StrRef&, Messaging::StrRef&);

    virtual void release(const Handler&);
 
protected:
    struct NoDetails
    {};

    explicit TcpRecoveryService(const NoDetails&);
 
private:
    class Details;
 
    // Shared details.
    Details* details_;
 
    // Copying is not assumed.
 
    TcpRecoveryService(const TcpRecoveryService&);
 
    TcpRecoveryService& operator=(const TcpRecoveryService&);
};
 
ONIXS_CMEMDH_NAMESPACE_END