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/ConflatedUDP/Watch.h>
#include <OnixS/CME/ConflatedUDP/String.h>
#include <OnixS/CME/ConflatedUDP/Integral.h>
 
 
ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

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

ONIXS_CONFLATEDUDP_LTWT_CLASS
TcpRecoverySettings
{
    std::string username_;
    std::string password_;
 
    UInt32 acquisitionTimeout_;
 
    UInt32 maxRequests_;
 
    WatchService* watch_;
 
public:
    TcpRecoverySettings()
        : username_()
        , password_()
        , acquisitionTimeout_(500)
        , maxRequests_(15)
        , watch_(&UtcWatch::service())
    {
    }

    ~TcpRecoverySettings()
    {
    }

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

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

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

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

    UInt32 
    acquisitionTimeout() const
    {
        return acquisitionTimeout_;
    }

    void 
    acquisitionTimeout(
        UInt32 acquisitionTimeout)
    {
        acquisitionTimeout_ = 
            acquisitionTimeout;
    }

    UInt32 maxRequests() const
    {
        return maxRequests_;
    }

    void 
    maxRequests(
        UInt32 maxRequests)
    {
        if (0 < maxRequests)
        {
            maxRequests_ = maxRequests;
        }
        else
        {
            throwZeroTcpRecoveryRequestLimit();
        }
    }

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

    void 
    watch(
        WatchService& watch)
    {
        watch_ = &watch;
    }
};

ONIXS_CONFLATEDUDP_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_CONFLATEDUDP_EXPORTED_CLASS_DECL
(
    Handler
);

ONIXS_CONFLATEDUDP_EXPORTED_CLASS
TcpRecoveryService
{
    class Details;
 
    // Shared details. 
    Details* details_;
 
    // Copying is not assumed. 
 
    TcpRecoveryService(
        const TcpRecoveryService&);
 
    TcpRecoveryService& 
    operator =(
        const TcpRecoveryService&);
 
protected:
    struct NoDetails {};

    explicit 
    TcpRecoveryService(
        const NoDetails&);
 
public:
    TcpRecoveryService(
        const TcpRecoverySettings&);

    virtual ~TcpRecoveryService();

    virtual 
    void 
    brief(
        std::string&);

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

    virtual 
    void 
    release(
        const Handler&);
};
 
ONIXS_CONFLATEDUDP_NAMESPACE_END