Source/Client/ClientConnection.h - master - Mr.Stalin/FOnline-Engine

Source/Client/ClientConnection.h
124 строки4 KB
cvet
Refactor ClientConnection: Change message history storage to deque and limit size; update debugger bind host to localhost
25 июл 2026, 14:39
25 июл 2026, 14:39fda8ee3
//      __________        ___               ______            _
//     / ____/ __ \____  / (_)___  ___     / ____/___  ____ _(_)___  ___
//    / /_  / / / / __ \/ / / __ \/ _ \   / __/ / __ \/ __ `/ / __ \/ _ `
//   / __/ / /_/ / / / / / / / / /  __/  / /___/ / / / /_/ / / / / /  __/
//  /_/    \____/_/ /_/_/_/_/ /_/\___/  /_____/_/ /_/\__, /_/_/ /_/\___/
//                                                  /____/
// FOnline Engine
// https://fonline.ru
// https://github.com/cvet/fonline
//
// MIT License
//
// Copyright (c) 2006 - 2026, Anton Tsvetinskiy aka cvet <cvet@tut.by>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//

#pragma once

#include "Common.h"

#include "NetBuffer.h"
#include "NetworkClient.h"
#include "Settings.h"

FO_BEGIN_NAMESPACE

FO_DECLARE_EXCEPTION(ClientConnectionException);

class ClientConnection final
{
public:
    enum class ConnectResult : uint8_t
    {
        Success,
        CompatibilityOutdated,
        UpdaterOutdated,
        Failed,
    };

    using ConnectCallback = function<void(ConnectResult result)>;
    using DisconnectCallback = function<void()>;
    using MessageCallback = function<void()>;

    ClientConnection() = delete;
    explicit ClientConnection(ptr<ClientNetworkSettings> settings);
    ClientConnection(const ClientConnection&) = delete;
    ClientConnection(ClientConnection&&) noexcept = delete;
    auto operator=(const ClientConnection&) = delete;
    auto operator=(ClientConnection&&) noexcept = delete;
    ~ClientConnection() = default;

    [[nodiscard]] auto IsConnecting() const noexcept -> bool { return _netConnection && !_wasHandshake; }
    [[nodiscard]] auto IsConnected() const noexcept -> bool { return _netConnection && _wasHandshake; }
    [[nodiscard]] auto GetBytesSend() const noexcept -> size_t { return _bytesSend; }
    [[nodiscard]] auto GetBytesReceived() const noexcept -> size_t { return _bytesReceived; }
    [[nodiscard]] auto GetUnpackedBytesReceived() const noexcept -> size_t { return _bytesRealReceived; }

    void SetConnectHandler(ConnectCallback handler);
    void SetDisconnectHandler(DisconnectCallback handler);
    void AddMessageHandler(NetMessage msg, MessageCallback handler);
    void Connect();
    void Process();
    void Disconnect();
    void FlushPendingData();

    ptr<NetInBuffer> InBuf {&_netIn};
    ptr<NetOutBuffer> OutBuf {&_netOut};

private:
    void CreateNetworkConnection(bool use_udp);
    void ProcessConnection();
    auto ReceiveData() -> bool;
    void SendData();
    auto TryFallbackToTcp() -> bool;

    void Net_SendHandshake();
    void Net_OnHandshakeAnswer();
    void Net_OnPing();

    ptr<ClientNetworkSettings> _settings;
    unique_nptr<NetworkClientConnection> _netConnection {};
    bool _connectingOverUdp {};
    bool _connectingHandled {};
    bool _udpFallbackTried {};
    bool _wasHandshake {};
    ConnectCallback _connectCallback {};
    DisconnectCallback _disconnectCallback {};
    NetInBuffer _netIn;
    NetOutBuffer _netOut;
    StreamDecompressor _decompressor {};
    vector<uint8_t> _unpackedReceivedBuf {};
    size_t _bytesSend {};
    size_t _bytesReceived {};
    size_t _bytesRealReceived {};
    unordered_map<NetMessage, MessageCallback> _handlers {};
    optional<nanotime> _artificalLagTime {};
    std::mt19937 _randomGenerator {MakeSeededRandomGenerator()};
    nanotime _pingTime {};
    nanotime _pingCallTime {};
    size_t _msgCount {};
#if FO_DEBUG
    static constexpr size_t NET_MESSAGE_HISTORY_LIMIT = 1024;
    deque<NetMessage> _msgHistory {};
#endif
};

FO_END_NAMESPACE