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.
This commit is contained in:
Lioncash 2018-04-16 16:02:21 -04:00
parent dfd6a228a6
commit ca6a2970ea
No known key found for this signature in database
GPG Key ID: 4E3C3CC1031BA9C7
6 changed files with 44 additions and 19 deletions

View File

@ -32,8 +32,21 @@ TraversalClient::TraversalClient(ENetHost* netHost, const std::string& server, c
ReconnectToServer(); 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() void TraversalClient::ReconnectToServer()

View File

@ -41,6 +41,11 @@ public:
}; };
TraversalClient(ENetHost* netHost, const std::string& server, const u16 port); TraversalClient(ENetHost* netHost, const std::string& server, const u16 port);
~TraversalClient(); ~TraversalClient();
TraversalHostId GetHostID() const;
State GetState() const;
FailureReason GetFailureReason() const;
void Reset(); void Reset();
void ConnectToClient(const std::string& host); void ConnectToClient(const std::string& host);
void ReconnectToServer(); void ReconnectToServer();
@ -49,11 +54,7 @@ public:
bool TestPacket(u8* data, size_t size, ENetAddress* from); bool TestPacket(u8* data, size_t size, ENetAddress* from);
void HandleResends(); void HandleResends();
ENetHost* m_NetHost;
TraversalClientClient* m_Client; TraversalClientClient* m_Client;
TraversalHostId m_HostId;
State m_State;
FailureReason m_FailureReason;
private: private:
struct OutgoingTraversalPacketInfo struct OutgoingTraversalPacketInfo
@ -68,6 +69,11 @@ private:
void OnFailure(FailureReason reason); void OnFailure(FailureReason reason);
void HandlePing(); void HandlePing();
static int ENET_CALLBACK InterceptCallback(ENetHost* host, ENetEvent* event); static int ENET_CALLBACK InterceptCallback(ENetHost* host, ENetEvent* event);
ENetHost* m_NetHost;
TraversalHostId m_HostId;
State m_State;
FailureReason m_FailureReason;
TraversalRequestId m_ConnectRequestId; TraversalRequestId m_ConnectRequestId;
bool m_PendingConnect; bool m_PendingConnect;
std::list<OutgoingTraversalPacketInfo> m_OutgoingTraversalPackets; std::list<OutgoingTraversalPacketInfo> m_OutgoingTraversalPackets;

View File

@ -134,7 +134,7 @@ NetPlayClient::NetPlayClient(const std::string& address, const u16 port, NetPlay
m_traversal_client = g_TraversalClient.get(); m_traversal_client = g_TraversalClient.get();
// If we were disconnected in the background, reconnect. // 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->ReconnectToServer();
m_traversal_client->m_Client = this; m_traversal_client->m_Client = this;
m_host_spec = address; m_host_spec = address;
@ -909,17 +909,18 @@ void NetPlayClient::ClearBuffers()
// called from ---NETPLAY--- thread // called from ---NETPLAY--- thread
void NetPlayClient::OnTraversalStateChanged() void NetPlayClient::OnTraversalStateChanged()
{ {
const TraversalClient::State state = m_traversal_client->GetState();
if (m_connection_state == ConnectionState::WaitingForTraversalClientConnection && if (m_connection_state == ConnectionState::WaitingForTraversalClientConnection &&
m_traversal_client->m_State == TraversalClient::Connected) state == TraversalClient::Connected)
{ {
m_connection_state = ConnectionState::WaitingForTraversalClientConnectReady; m_connection_state = ConnectionState::WaitingForTraversalClientConnectReady;
m_traversal_client->ConnectToClient(m_host_spec); m_traversal_client->ConnectToClient(m_host_spec);
} }
else if (m_connection_state != ConnectionState::Failure && else if (m_connection_state != ConnectionState::Failure && state == TraversalClient::Failure)
m_traversal_client->m_State == TraversalClient::Failure)
{ {
Disconnect(); Disconnect();
m_dialog->OnTraversalError(m_traversal_client->m_FailureReason); m_dialog->OnTraversalError(m_traversal_client->GetFailureReason());
} }
} }

View File

@ -90,7 +90,7 @@ NetPlayServer::NetPlayServer(const u16 port, const bool forward_port,
m_server = g_MainNetHost.get(); m_server = g_MainNetHost.get();
if (g_TraversalClient->m_State == TraversalClient::Failure) if (g_TraversalClient->GetState() == TraversalClient::Failure)
g_TraversalClient->ReconnectToServer(); g_TraversalClient->ReconnectToServer();
} }
else else
@ -736,8 +736,8 @@ unsigned int NetPlayServer::OnData(sf::Packet& packet, Client& player)
void NetPlayServer::OnTraversalStateChanged() void NetPlayServer::OnTraversalStateChanged()
{ {
if (m_dialog && m_traversal_client->m_State == TraversalClient::Failure) if (m_dialog && m_traversal_client->GetState() == TraversalClient::Failure)
m_dialog->OnTraversalError(m_traversal_client->m_FailureReason); m_dialog->OnTraversalError(m_traversal_client->GetFailureReason());
} }
// called from ---GUI--- thread // called from ---GUI--- thread

View File

@ -360,19 +360,22 @@ void NetPlayDialog::UpdateGUI()
// Update Room ID / IP label // Update Room ID / IP label
if (m_use_traversal && m_room_box->currentIndex() == 0) if (m_use_traversal && m_room_box->currentIndex() == 0)
{ {
switch (g_TraversalClient->m_State) switch (g_TraversalClient->GetState())
{ {
case TraversalClient::Connecting: case TraversalClient::Connecting:
m_hostcode_label->setText(tr("...")); m_hostcode_label->setText(tr("..."));
m_hostcode_action_button->setEnabled(false); m_hostcode_action_button->setEnabled(false);
break; break;
case TraversalClient::Connected: 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->setEnabled(true);
m_hostcode_action_button->setText(tr("Copy")); m_hostcode_action_button->setText(tr("Copy"));
m_is_copy_button_retry = false; m_is_copy_button_retry = false;
break; break;
}
case TraversalClient::Failure: case TraversalClient::Failure:
m_hostcode_label->setText(tr("Error")); m_hostcode_label->setText(tr("Error"));
m_hostcode_action_button->setText(tr("Retry")); m_hostcode_action_button->setText(tr("Retry"));

View File

@ -777,7 +777,7 @@ void NetPlayDialog::UpdateHostLabel()
if (sel == 0) if (sel == 0)
{ {
// the traversal ID // the traversal ID
switch (g_TraversalClient->m_State) switch (g_TraversalClient->GetState())
{ {
case TraversalClient::Connecting: case TraversalClient::Connecting:
m_host_label->SetForegroundColour(*wxLIGHT_GREY); m_host_label->SetForegroundColour(*wxLIGHT_GREY);
@ -786,13 +786,15 @@ void NetPlayDialog::UpdateHostLabel()
m_host_copy_btn->Disable(); m_host_copy_btn->Disable();
break; break;
case TraversalClient::Connected: case TraversalClient::Connected:
{
const auto host_id = g_TraversalClient->GetHostID();
m_host_label->SetForegroundColour(*wxBLACK); m_host_label->SetForegroundColour(*wxBLACK);
m_host_label->SetLabel( m_host_label->SetLabel(wxString(host_id.data(), host_id.size()));
wxString(g_TraversalClient->m_HostId.data(), g_TraversalClient->m_HostId.size()));
m_host_copy_btn->SetLabel(_("Copy")); m_host_copy_btn->SetLabel(_("Copy"));
m_host_copy_btn->Enable(); m_host_copy_btn->Enable();
m_host_copy_btn_is_retry = false; m_host_copy_btn_is_retry = false;
break; break;
}
case TraversalClient::Failure: case TraversalClient::Failure:
m_host_label->SetForegroundColour(*wxBLACK); m_host_label->SetForegroundColour(*wxBLACK);
m_host_label->SetLabel("..."); m_host_label->SetLabel("...");