From ca6a2970ea83d0850040aa3334e52d83ae0657dc Mon Sep 17 00:00:00 2001 From: Lioncash Date: Mon, 16 Apr 2018 16:02:21 -0400 Subject: [PATCH] TraversalClient: Make data externally read-only members private These are only ever queried for state, not written. Therefore, prevent writing to the members and make them private. --- Source/Core/Common/TraversalClient.cpp | 15 ++++++++++++++- Source/Core/Common/TraversalClient.h | 14 ++++++++++---- Source/Core/Core/NetPlayClient.cpp | 11 ++++++----- Source/Core/Core/NetPlayServer.cpp | 6 +++--- Source/Core/DolphinQt2/NetPlay/NetPlayDialog.cpp | 9 ++++++--- Source/Core/DolphinWX/NetPlay/NetWindow.cpp | 8 +++++--- 6 files changed, 44 insertions(+), 19 deletions(-) diff --git a/Source/Core/Common/TraversalClient.cpp b/Source/Core/Common/TraversalClient.cpp index 13089b958c..96fe7c75d6 100644 --- a/Source/Core/Common/TraversalClient.cpp +++ b/Source/Core/Common/TraversalClient.cpp @@ -32,8 +32,21 @@ TraversalClient::TraversalClient(ENetHost* netHost, const std::string& server, c ReconnectToServer(); } -TraversalClient::~TraversalClient() +TraversalClient::~TraversalClient() = default; + +TraversalHostId TraversalClient::GetHostID() const { + return m_HostId; +} + +TraversalClient::State TraversalClient::GetState() const +{ + return m_State; +} + +TraversalClient::FailureReason TraversalClient::GetFailureReason() const +{ + return m_FailureReason; } void TraversalClient::ReconnectToServer() diff --git a/Source/Core/Common/TraversalClient.h b/Source/Core/Common/TraversalClient.h index e85453e0e9..ce6a78e768 100644 --- a/Source/Core/Common/TraversalClient.h +++ b/Source/Core/Common/TraversalClient.h @@ -41,6 +41,11 @@ public: }; TraversalClient(ENetHost* netHost, const std::string& server, const u16 port); ~TraversalClient(); + + TraversalHostId GetHostID() const; + State GetState() const; + FailureReason GetFailureReason() const; + void Reset(); void ConnectToClient(const std::string& host); void ReconnectToServer(); @@ -49,11 +54,7 @@ public: bool TestPacket(u8* data, size_t size, ENetAddress* from); void HandleResends(); - ENetHost* m_NetHost; TraversalClientClient* m_Client; - TraversalHostId m_HostId; - State m_State; - FailureReason m_FailureReason; private: struct OutgoingTraversalPacketInfo @@ -68,6 +69,11 @@ private: void OnFailure(FailureReason reason); void HandlePing(); static int ENET_CALLBACK InterceptCallback(ENetHost* host, ENetEvent* event); + + ENetHost* m_NetHost; + TraversalHostId m_HostId; + State m_State; + FailureReason m_FailureReason; TraversalRequestId m_ConnectRequestId; bool m_PendingConnect; std::list m_OutgoingTraversalPackets; diff --git a/Source/Core/Core/NetPlayClient.cpp b/Source/Core/Core/NetPlayClient.cpp index 2f28527a5e..be766d81ad 100644 --- a/Source/Core/Core/NetPlayClient.cpp +++ b/Source/Core/Core/NetPlayClient.cpp @@ -134,7 +134,7 @@ NetPlayClient::NetPlayClient(const std::string& address, const u16 port, NetPlay m_traversal_client = g_TraversalClient.get(); // If we were disconnected in the background, reconnect. - if (m_traversal_client->m_State == TraversalClient::Failure) + if (m_traversal_client->GetState() == TraversalClient::Failure) m_traversal_client->ReconnectToServer(); m_traversal_client->m_Client = this; m_host_spec = address; @@ -909,17 +909,18 @@ void NetPlayClient::ClearBuffers() // called from ---NETPLAY--- thread void NetPlayClient::OnTraversalStateChanged() { + const TraversalClient::State state = m_traversal_client->GetState(); + if (m_connection_state == ConnectionState::WaitingForTraversalClientConnection && - m_traversal_client->m_State == TraversalClient::Connected) + state == TraversalClient::Connected) { m_connection_state = ConnectionState::WaitingForTraversalClientConnectReady; m_traversal_client->ConnectToClient(m_host_spec); } - else if (m_connection_state != ConnectionState::Failure && - m_traversal_client->m_State == TraversalClient::Failure) + else if (m_connection_state != ConnectionState::Failure && state == TraversalClient::Failure) { Disconnect(); - m_dialog->OnTraversalError(m_traversal_client->m_FailureReason); + m_dialog->OnTraversalError(m_traversal_client->GetFailureReason()); } } diff --git a/Source/Core/Core/NetPlayServer.cpp b/Source/Core/Core/NetPlayServer.cpp index e41146a543..2ff168cc0d 100644 --- a/Source/Core/Core/NetPlayServer.cpp +++ b/Source/Core/Core/NetPlayServer.cpp @@ -90,7 +90,7 @@ NetPlayServer::NetPlayServer(const u16 port, const bool forward_port, m_server = g_MainNetHost.get(); - if (g_TraversalClient->m_State == TraversalClient::Failure) + if (g_TraversalClient->GetState() == TraversalClient::Failure) g_TraversalClient->ReconnectToServer(); } else @@ -736,8 +736,8 @@ unsigned int NetPlayServer::OnData(sf::Packet& packet, Client& player) void NetPlayServer::OnTraversalStateChanged() { - if (m_dialog && m_traversal_client->m_State == TraversalClient::Failure) - m_dialog->OnTraversalError(m_traversal_client->m_FailureReason); + if (m_dialog && m_traversal_client->GetState() == TraversalClient::Failure) + m_dialog->OnTraversalError(m_traversal_client->GetFailureReason()); } // called from ---GUI--- thread diff --git a/Source/Core/DolphinQt2/NetPlay/NetPlayDialog.cpp b/Source/Core/DolphinQt2/NetPlay/NetPlayDialog.cpp index 5747b46837..556188b911 100644 --- a/Source/Core/DolphinQt2/NetPlay/NetPlayDialog.cpp +++ b/Source/Core/DolphinQt2/NetPlay/NetPlayDialog.cpp @@ -360,19 +360,22 @@ void NetPlayDialog::UpdateGUI() // Update Room ID / IP label if (m_use_traversal && m_room_box->currentIndex() == 0) { - switch (g_TraversalClient->m_State) + switch (g_TraversalClient->GetState()) { case TraversalClient::Connecting: m_hostcode_label->setText(tr("...")); m_hostcode_action_button->setEnabled(false); break; case TraversalClient::Connected: - m_hostcode_label->setText(QString::fromStdString( - std::string(g_TraversalClient->m_HostId.data(), g_TraversalClient->m_HostId.size()))); + { + const auto host_id = g_TraversalClient->GetHostID(); + m_hostcode_label->setText( + QString::fromStdString(std::string(host_id.begin(), host_id.end()))); m_hostcode_action_button->setEnabled(true); m_hostcode_action_button->setText(tr("Copy")); m_is_copy_button_retry = false; break; + } case TraversalClient::Failure: m_hostcode_label->setText(tr("Error")); m_hostcode_action_button->setText(tr("Retry")); diff --git a/Source/Core/DolphinWX/NetPlay/NetWindow.cpp b/Source/Core/DolphinWX/NetPlay/NetWindow.cpp index cd4bba69a6..1ece3e1bc1 100644 --- a/Source/Core/DolphinWX/NetPlay/NetWindow.cpp +++ b/Source/Core/DolphinWX/NetPlay/NetWindow.cpp @@ -777,7 +777,7 @@ void NetPlayDialog::UpdateHostLabel() if (sel == 0) { // the traversal ID - switch (g_TraversalClient->m_State) + switch (g_TraversalClient->GetState()) { case TraversalClient::Connecting: m_host_label->SetForegroundColour(*wxLIGHT_GREY); @@ -786,13 +786,15 @@ void NetPlayDialog::UpdateHostLabel() m_host_copy_btn->Disable(); break; case TraversalClient::Connected: + { + const auto host_id = g_TraversalClient->GetHostID(); m_host_label->SetForegroundColour(*wxBLACK); - m_host_label->SetLabel( - wxString(g_TraversalClient->m_HostId.data(), g_TraversalClient->m_HostId.size())); + m_host_label->SetLabel(wxString(host_id.data(), host_id.size())); m_host_copy_btn->SetLabel(_("Copy")); m_host_copy_btn->Enable(); m_host_copy_btn_is_retry = false; break; + } case TraversalClient::Failure: m_host_label->SetForegroundColour(*wxBLACK); m_host_label->SetLabel("...");