Merge branch 'develop', heartbeat systems

client/scenes/in_world.cpp

@@ -140,6 +140,20 @@ void InWorld::Update() {
 	//update the camera
 	camera.x = localCharacter->GetOrigin().x - camera.marginX;
 	camera.y = localCharacter->GetOrigin().y - camera.marginY;
+
+	//check the connection
+	if (Clock::now() - lastBeat > std::chrono::seconds(5)) {
+		if (attemptedBeats > 2) {
+			throw(std::runtime_error("Connection lost"));
+		}
+
+		ServerPacket newPacket;
+		newPacket.type = SerialPacketType::PING;
+		network.SendTo(Channels::SERVER, &newPacket);
+
+		attemptedBeats++;
+		lastBeat = Clock::now();
+	}
 }
 
 void InWorld::FrameEnd() {
@@ -270,8 +284,14 @@ void InWorld::KeyUp(SDL_KeyboardEvent const& key) {
 
 void InWorld::HandlePacket(SerialPacket* const argPacket) {
 	switch(argPacket->type) {
+		case SerialPacketType::PING:
+			HandlePing(static_cast<ServerPacket*>(argPacket));
+		break;
+		case SerialPacketType::PONG:
+			HandlePong(static_cast<ServerPacket*>(argPacket));
+		break;
 		case SerialPacketType::DISCONNECT:
-			HandleDisconnect(argPacket);
+			HandleDisconnect(static_cast<ClientPacket*>(argPacket));
 		break;
 		case SerialPacketType::CHARACTER_NEW:
 			HandleCharacterNew(static_cast<CharacterPacket*>(argPacket));
@@ -292,7 +312,23 @@ void InWorld::HandlePacket(SerialPacket* const argPacket) {
 	}
 }
 
-void InWorld::HandleDisconnect(SerialPacket* const argPacket) {
+void InWorld::HandlePing(ServerPacket* const argPacket) {
+	ServerPacket newPacket;
+	newPacket.type = SerialPacketType::PONG;
+	network.SendTo(argPacket->srcAddress, &newPacket);
+}
+
+void InWorld::HandlePong(ServerPacket* const argPacket) {
+	if (network.GetIPAddress(Channels::SERVER)->host != argPacket->srcAddress.host) {
+		throw(std::runtime_error("Heartbeat message received from unknown source"));
+	}
+
+	attemptedBeats = 0;
+	lastBeat = Clock::now();
+}
+
+void InWorld::HandleDisconnect(ClientPacket* const argPacket) {
+	//TODO: More needed in the disconnection
 	SetNextScene(SceneList::CLEANUP);
 }
 

client/scenes/in_world.hpp

@@ -46,6 +46,8 @@
 //STL
 #include <map>
 
+#include <chrono>
+
 class InWorld : public BaseScene {
 public:
 	//Public access members
@@ -75,7 +77,9 @@ protected:
 
 	//Network handlers
 	void HandlePacket(SerialPacket* const);
-	void HandleDisconnect(SerialPacket* const);
+	void HandlePing(ServerPacket* const);
+	void HandlePong(ServerPacket* const);
+	void HandleDisconnect(ClientPacket* const);
 	void HandleCharacterNew(CharacterPacket* const);
 	void HandleCharacterDelete(CharacterPacket* const);
 	void HandleCharacterUpdate(CharacterPacket* const);
@@ -119,6 +123,11 @@ protected:
 
 	//game
 	Character* localCharacter = nullptr;
+
+	//connections
+	typedef std::chrono::steady_clock Clock;
+	Clock::time_point lastBeat = Clock::now();
+	int attemptedBeats = 0;
 };
 
 #endif

client/scenes/lobby_menu.cpp

@@ -217,7 +217,7 @@ void LobbyMenu::HandleBroadcastResponse(ServerPacket* const argPacket) {
 void LobbyMenu::HandleJoinResponse(ClientPacket* const argPacket) {
 	clientIndex = argPacket->clientIndex;
 	accountIndex = argPacket->accountIndex;
-	network.Bind(&argPacket->srcAddress, Channels::SERVER);
+	network.Bind(argPacket->srcAddress, Channels::SERVER);
 	SetNextScene(SceneList::INWORLD);
 
 	//send this player's character info
@@ -251,6 +251,6 @@ void LobbyMenu::SendJoinRequest() {
 		strncpy(packet.username, config["client.username"].c_str(), PACKET_STRING_SIZE);
 
 		//join the selected server
-		network.SendTo(&selection->address, &packet);
+		network.SendTo(selection->address, &packet);
 		selection = nullptr;
 }

common/network/serial_utility.cpp

@@ -40,6 +40,8 @@ void deserialCopy(void** buffer, void* data, int size) {
 	*buffer = reinterpret_cast<char*>(*buffer) + size;
 }
 
+//DOCS: The server and client MUST use the correct packet types
+
 //main switch functions
 void serializePacket(void* buffer, SerialPacketBase* packet) {
 	switch(packet->type) {

common/network/udp_network_utility.cpp

@@ -55,11 +55,11 @@ int UDPNetworkUtility::Bind(const char* ip, int port, int channel) {
 		throw(std::runtime_error("Failed to resolve a host"));
 	}
 
-	return Bind(&add, channel);
+	return Bind(add, channel);
 }
 
-int UDPNetworkUtility::Bind(IPaddress* add, int channel) {
-	int ret = SDLNet_UDP_Bind(socket, channel, add);
+int UDPNetworkUtility::Bind(IPaddress add, int channel) {
+	int ret = SDLNet_UDP_Bind(socket, channel, &add);
 
 	if (ret < 0) {
 		throw(std::runtime_error("Failed to bind to a channel"));
@@ -82,17 +82,17 @@ int UDPNetworkUtility::SendTo(const char* ip, int port, void* data, int len) {
 		throw(std::runtime_error("Failed to resolve a host"));
 	}
 
-	SendTo(&add, data, len);
+	SendTo(add, data, len);
 }
 
-int UDPNetworkUtility::SendTo(IPaddress* add, void* data, int len) {
+int UDPNetworkUtility::SendTo(IPaddress add, void* data, int len) {
 	if (len > packet->maxlen) {
 		throw(std::runtime_error("The buffer is to large for the UDPpacket"));
 	}
 	memset(packet->data, 0, packet->maxlen);
 	memcpy(packet->data, data, len);
 	packet->len = len;
-	packet->address = *add;
+	packet->address = add;
 
 	int ret = SDLNet_UDP_Send(socket, -1, packet);
 
@@ -162,14 +162,14 @@ int UDPNetworkUtility::SendTo(const char* ip, int port, SerialPacketBase* serial
 		throw(std::runtime_error("Failed to resolve a host"));
 	}
 
-	SendTo(&add, serialPacket);
+	SendTo(add, serialPacket);
 }
 
-int UDPNetworkUtility::SendTo(IPaddress* add, SerialPacketBase* serialPacket) {
+int UDPNetworkUtility::SendTo(IPaddress add, SerialPacketBase* serialPacket) {
 	memset(packet->data, 0, packet->maxlen);
 	serializePacket(packet->data, serialPacket);
 	packet->len = PACKET_BUFFER_SIZE;
-	packet->address = *add;
+	packet->address = add;
 
 	int ret = SDLNet_UDP_Send(socket, -1, packet);
 

common/network/udp_network_utility.hpp

@@ -36,7 +36,7 @@ public:
 
 	//bind to a channel
 	int Bind(const char* ip, int port, int channel = -1);
-	int Bind(IPaddress* add, int channel = -1);
+	int Bind(IPaddress add, int channel = -1);
 	void Unbind(int channel);
 
 	IPaddress* GetIPAddress(int channel) {
@@ -45,14 +45,14 @@ public:
 
 	//send a buffer
 	int SendTo(const char* ip, int port, void* data, int len);
-	int SendTo(IPaddress* add, void* data, int len);
+	int SendTo(IPaddress add, void* data, int len);
 	int SendTo(int channel, void* data, int len);
 	int SendToAllChannels(void* data, int len);
 	int Receive();
 
 	//send a SerialPacketBase
 	int SendTo(const char* ip, int port, SerialPacketBase* serialPacket);
-	int SendTo(IPaddress* add, SerialPacketBase* serialPacket);
+	int SendTo(IPaddress add, SerialPacketBase* serialPacket);
 	int SendTo(int channel, SerialPacketBase* serialPacket);
 	int SendToAllChannels(SerialPacketBase* serialPacket);
 	int Receive(SerialPacketBase* serialPacket);

server/client_data.cpp

@@ -0,0 +1,32 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "client_data.hpp"
+
+int ClientData::IncrementAttempts() {
+	lastBeat = Clock::now();
+	return attemptedBeats++;
+}
+
+int ClientData::ResetAttempts() {
+	lastBeat = Clock::now();
+	return attemptedBeats = 0;
+}

server/client_data.hpp

@@ -24,9 +24,31 @@
 
 #include "SDL/SDL_net.h"
 
-struct ClientData {
+#include <chrono>
+
+//TODO: ClientManager?
+class ClientData {
+public:
+	typedef std::chrono::steady_clock Clock;
+
+	ClientData() = default;
+	ClientData(IPaddress add): address(add) {}
+	~ClientData() = default;
+
+	IPaddress SetAddress(IPaddress add) { return address = add; }
+	IPaddress GetAddress() { return address; }
+
+	Clock::time_point GetLastBeat() { return lastBeat; }
+
+	int GetAttempts() { return attemptedBeats; }
+	int IncrementAttempts();
+	int ResetAttempts();
+
+private:
 	IPaddress address = {0,0};
-	//TODO: ping system?
+
+	Clock::time_point lastBeat = Clock::now();
+	int attemptedBeats = 0;
 };
 
 #endif

server/server_application.hpp

@@ -61,10 +61,12 @@ private:
 	void HandlePacket(SerialPacket* const);
 
 	//basic connections
-	void HandleBroadcastRequest(SerialPacket* const);
+	void HandlePing(ServerPacket* const);
+	void HandlePong(ServerPacket* const);
+	void HandleBroadcastRequest(ServerPacket* const);
 	void HandleJoinRequest(ClientPacket* const);
 	void HandleDisconnect(ClientPacket* const);
-	void HandleShutdown(SerialPacket* const);
+	void HandleShutdown(ClientPacket* const);
 
 	//map management
 	void HandleRegionRequest(RegionPacket* const);
@@ -79,6 +81,7 @@ private:
 
 	//utility methods
 	//TODO: a function that only sends to characters in a certain proximity
+	void CleanupLostConnection(int index);
 	void PumpPacket(SerialPacket* const);
 	void PumpCharacterUnload(int uid);
 	void CopyCharacterToPacket(CharacterPacket* const packet, int characterIndex);

server/server_logic.cpp

@@ -26,6 +26,7 @@
 #include "utility.hpp"
 
 #include <stdexcept>
+#include <chrono>
 #include <iostream>
 #include <string>
 
@@ -144,6 +145,24 @@ void ServerApplication::Proc() {
 		//update the internals
 		//BUG: #30 Update the internals i.e. player positions
 
+		//TODO: This could be checked only every few seconds
+		//Check connections
+		for (auto& it : clientMap) {
+			if (std::chrono::steady_clock::now() - it.second.GetLastBeat() > std::chrono::seconds(5)) {
+				ServerPacket newPacket;
+				newPacket.type = SerialPacketType::PING;
+				network.SendTo(it.second.GetAddress(), &newPacket);
+				it.second.IncrementAttempts();
+			}
+
+			if (it.second.GetAttempts() > 2) {
+				CleanupLostConnection(it.first);
+
+				//all iterators are invalid, so we can't continue
+				break;
+			}
+		}
+
 		//give the computer a break
 		SDL_Delay(10);
 	}
@@ -178,8 +197,14 @@ void ServerApplication::Quit() {
 void ServerApplication::HandlePacket(SerialPacket* const argPacket) {
 	switch(argPacket->type) {
 		//basic connections
+		case SerialPacketType::PING:
+			HandlePing(static_cast<ServerPacket*>(argPacket));
+		break;
+		case SerialPacketType::PONG:
+			HandlePong(static_cast<ServerPacket*>(argPacket));
+		break;
 		case SerialPacketType::BROADCAST_REQUEST:
-			HandleBroadcastRequest(static_cast<SerialPacket*>(argPacket));
+			HandleBroadcastRequest(static_cast<ServerPacket*>(argPacket));
 		break;
 		case SerialPacketType::JOIN_REQUEST:
 			HandleJoinRequest(static_cast<ClientPacket*>(argPacket));
@@ -188,7 +213,7 @@ void ServerApplication::HandlePacket(SerialPacket* const argPacket) {
 			HandleDisconnect(static_cast<ClientPacket*>(argPacket));
 		break;
 		case SerialPacketType::SHUTDOWN:
-			HandleShutdown(static_cast<SerialPacket*>(argPacket));
+			HandleShutdown(static_cast<ClientPacket*>(argPacket));
 		break;
 
 		//map management

server/server_methods.cpp

@@ -27,7 +27,27 @@
 //basic connections
 //-------------------------
 
-void ServerApplication::HandleBroadcastRequest(SerialPacket* const argPacket) {
+void ServerApplication::HandlePing(ServerPacket* const argPacket) {
+	ServerPacket newPacket;
+	newPacket.type = SerialPacketType::PONG;
+	network.SendTo(argPacket->srcAddress, &newPacket);
+}
+
+void ServerApplication::HandlePong(ServerPacket* const argPacket) {
+	//find and update the specified client
+
+	//BUGFIX: running multiple clients on one computer will result in matching host values; check the ports too
+	for (auto& it : clientMap) {
+		if (it.second.GetAddress().host == argPacket->srcAddress.host &&
+			it.second.GetAddress().port == argPacket->srcAddress.port
+			) {
+			it.second.ResetAttempts();
+			break;
+		}
+	}
+}
+
+void ServerApplication::HandleBroadcastRequest(ServerPacket* const argPacket) {
 	//send the server's data
 	ServerPacket newPacket;
 
@@ -36,13 +56,13 @@ void ServerApplication::HandleBroadcastRequest(SerialPacket* const argPacket) {
 	newPacket.playerCount = characterMgr.GetContainer()->size();
 	newPacket.version = NETWORK_VERSION;
 
-	network.SendTo(&argPacket->srcAddress, static_cast<SerialPacket*>(&newPacket));
+	network.SendTo(argPacket->srcAddress, static_cast<SerialPacket*>(&newPacket));
 }
 
 void ServerApplication::HandleJoinRequest(ClientPacket* const argPacket) {
 	//create the new client
 	ClientData newClient;
-	newClient.address = argPacket->srcAddress;
+	newClient.SetAddress(argPacket->srcAddress);
 
 	//load the user account
 	//TODO: handle passwords
@@ -59,7 +79,7 @@ void ServerApplication::HandleJoinRequest(ClientPacket* const argPacket) {
 	newPacket.clientIndex = clientIndex;
 	newPacket.accountIndex = accountIndex;
 
-	network.SendTo(&newClient.address, static_cast<SerialPacket*>(&newPacket));
+	network.SendTo(newClient.GetAddress(), static_cast<SerialPacket*>(&newPacket));
 
 	//finished this routine
 	clientMap[clientIndex++] = newClient;
@@ -80,7 +100,7 @@ void ServerApplication::HandleDisconnect(ClientPacket* const argPacket) {
 
 	//forward to the specified client
 	network.SendTo(
-		&clientMap[ accountMgr.GetAccount(argPacket->accountIndex)->GetClientIndex() ].address,
+		clientMap[ accountMgr.GetAccount(argPacket->accountIndex)->GetClientIndex() ].GetAddress(),
 		static_cast<SerialPacket*>(argPacket)
 	);
 
@@ -102,7 +122,7 @@ void ServerApplication::HandleDisconnect(ClientPacket* const argPacket) {
 	std::cout << "Disconnection, " << clientMap.size() << " clients and " << accountMgr.GetContainer()->size() << " accounts total" << std::endl;
 }
 
-void ServerApplication::HandleShutdown(SerialPacket* const argPacket) {
+void ServerApplication::HandleShutdown(ClientPacket* const argPacket) {
 	//TODO: authenticate who is shutting the server down
 	/*Pseudocode:
 	if sender's account -> admin is not true then
@@ -115,7 +135,7 @@ void ServerApplication::HandleShutdown(SerialPacket* const argPacket) {
 	running = false;
 
 	//disconnect all clients
-	SerialPacket newPacket;
+	ClientPacket newPacket;
 	newPacket.type = SerialPacketType::DISCONNECT;
 	PumpPacket(&newPacket);
 
@@ -138,7 +158,7 @@ void ServerApplication::HandleRegionRequest(RegionPacket* const argPacket) {
 	newPacket.region = roomMgr.GetRoom(argPacket->roomIndex)->GetPager()->GetRegion(argPacket->x, argPacket->y);
 
 	//send the content
-	network.SendTo(&argPacket->srcAddress, static_cast<SerialPacket*>(&newPacket));
+	network.SendTo(argPacket->srcAddress, static_cast<SerialPacket*>(&newPacket));
 }
 
 //-------------------------
@@ -162,6 +182,8 @@ void ServerApplication::HandleCharacterNew(CharacterPacket* const argPacket) {
 		return;
 	}
 
+	//TODO: Make sure that a character's owner's account is loaded before continuing
+
 	//send this new character to all clients
 	CharacterPacket newPacket;
 	newPacket.type = SerialPacketType::CHARACTER_NEW;
@@ -237,7 +259,7 @@ void ServerApplication::HandleSynchronize(ClientPacket* const argPacket) {
 	for (auto& it : *characterMgr.GetContainer()) {
 		newPacket.characterIndex = it.first;
 		CopyCharacterToPacket(&newPacket, it.first);
-		network.SendTo(&client.address, static_cast<SerialPacket*>(&newPacket));
+		network.SendTo(client.GetAddress(), static_cast<SerialPacket*>(&newPacket));
 	}
 
 	//TODO: more in HandleSynchronize()
@@ -247,11 +269,52 @@ void ServerApplication::HandleSynchronize(ClientPacket* const argPacket) {
 //utility methods
 //-------------------------
 
+void ServerApplication::CleanupLostConnection(int clientIndex) {
+	//NOTE: This assumes each player has only one account and character at a time
+
+	//find the account
+	int accountIndex = -1;
+	for (auto& it : *accountMgr.GetContainer()) {
+		if (it.second.GetClientIndex() == clientIndex) {
+			accountIndex = it.first;
+			break;
+		}
+	}
+
+	//find the character
+	int characterIndex = -1;
+	for (auto& it : *characterMgr.GetContainer()) {
+		if (it.second.GetOwner() == accountIndex) {
+			characterIndex = it.first;
+			break;
+		}
+	}
+
+	//send a dissconnection message just in case
+	ClientPacket newPacket;
+	newPacket.type = SerialPacketType::DISCONNECT;
+	network.SendTo(clientMap[clientIndex].GetAddress(), &newPacket);
+
+	//clean up this mess
+	characterMgr.UnloadCharacter(characterIndex);
+	accountMgr.UnloadAccount(accountIndex);
+	clientMap.erase(clientIndex);
+
+	PumpCharacterUnload(characterIndex);
+
+	//output a message
+	std::cerr << "Connection lost: " << std::endl;
+	std::cerr << "\tClient: " << clientIndex << std::endl;
+	std::cerr << "\tAccount: " << accountIndex << std::endl;
+	std::cerr << "\tCharacter: " << characterIndex << std::endl;
+	std::cout << clientMap.size() << " clients and " << accountMgr.GetContainer()->size() << " accounts total" << std::endl;
+}
+
 //TODO: a function that only sends to characters in a certain proximity
 
 void ServerApplication::PumpPacket(SerialPacket* const argPacket) {
 	for (auto& it : clientMap) {
-		network.SendTo(&it.second.address, argPacket);
+		network.SendTo(it.second.GetAddress(), argPacket);
 	}
 }
 

todo.txt

@@ -1,16 +1,13 @@
-TODO: Sort out the *_cast<> stuff
-TODO: encapsulate the data structures
-TODO: Ping-pong and keep alive system
+TODO: Rejection messages
+TODO: The error handling is terrible
 TODO: Move the statistics into their own SQL table, instead of duplicating the structure a dozen times
 TODO: Get the rooms working, even if only via hotkeys
-TODO: Rejection messages
-TODO: Move the map system into it's own namespace
-TODO: The TileSheet class should implement the surface itself
-
 TODO: Fix shoddy movement
+
+TODO: Move the map system into it's own namespace?
+TODO: The TileSheet class should implement the surface itself
 TODO: make the whole thing more fault tolerant
 TODO: Authentication
-TODO: server is slaved to the client
 
 TODO: Time delay for requesting region packets
 TODO: command line parameters overriding config.cfg settings