xmrig/src/base/net/stratum/BaseClient.h

/* XMRig
 * Copyright 2010      Jeff Garzik <jgarzik@pobox.com>
 * Copyright 2012-2014 pooler      <pooler@litecoinpool.org>
 * Copyright 2014      Lucas Jones <https://github.com/lucasjones>
 * Copyright 2014-2016 Wolf9466    <https://github.com/OhGodAPet>
 * Copyright 2016      Jay D Dee   <jayddee246@gmail.com>
 * Copyright 2017-2018 XMR-Stak    <https://github.com/fireice-uk>, <https://github.com/psychocrypt>
 * Copyright 2018-2020 SChernykh   <https://github.com/SChernykh>
 * Copyright 2016-2020 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef XMRIG_BASECLIENT_H
#define XMRIG_BASECLIENT_H


#include <map>


#include "base/kernel/interfaces/IClient.h"
#include "base/net/stratum/Job.h"
#include "base/net/stratum/Pool.h"
#include "base/tools/Chrono.h"


namespace xmrig {


class IClientListener;
class SubmitResult;


class BaseClient : public IClient
{
public:
    BaseClient(int id, IClientListener *listener);

protected:
    inline bool isEnabled() const override                     { return m_enabled; }
    inline const Job &job() const override                     { return m_job; }
    inline const Pool &pool() const override                   { return m_pool; }
    inline const String &ip() const override                   { return m_ip; }
    inline int id() const override                             { return m_id; }
    inline int64_t sequence() const override                   { return m_sequence; }
    inline void setAlgo(const Algorithm &algo) override        { m_pool.setAlgo(algo); }
    inline void setEnabled(bool enabled) override              { m_enabled = enabled; }
    inline void setProxy(const ProxyUrl &proxy) override       { m_pool.setProxy(proxy); }
    inline void setQuiet(bool quiet) override                  { m_quiet = quiet; }
    inline void setRetries(int retries) override               { m_retries = retries; }
    inline void setRetryPause(uint64_t ms) override            { m_retryPause = ms; }

    void setPool(const Pool &pool) override;

protected:
    enum SocketState {
        UnconnectedState,
        HostLookupState,
        ConnectingState,
        ConnectedState,
        ClosingState,
        ReconnectingState
    };

    struct SendResult
    {
        inline SendResult(Callback &&callback) : callback(callback), ts(Chrono::steadyMSecs()) {}

        Callback callback;
        const uint64_t ts;
    };

    inline bool isQuiet() const { return m_quiet || m_failures >= m_retries; }

    bool handleResponse(int64_t id, const rapidjson::Value &result, const rapidjson::Value &error);
    bool handleSubmitResponse(int64_t id, const char *error = nullptr);

    bool m_quiet                    = false;
    IClientListener *m_listener;
    int m_id;
    int m_retries                   = 5;
    int64_t m_failures              = 0;
    Job m_job;
    Pool m_pool;
    SocketState m_state             = UnconnectedState;
    std::map<int64_t, SendResult> m_callbacks;
    std::map<int64_t, SubmitResult> m_results;
    String m_ip;
    String m_password;
    String m_rigId;
    String m_user;
    uint64_t m_retryPause           = 5000;

    static int64_t m_sequence;

private:
    bool m_enabled = true;
};


} /* namespace xmrig */


#endif /* XMRIG_BASECLIENT_H */