Moved all folders into common/

common/network/makefile

@@ -0,0 +1,29 @@
+#config
+INCLUDES+=. packet_types ../gameplay ../map ../utilities
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+	$(MAKE) -C packet_types
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/network/packet_types/character_packet.cpp

@@ -0,0 +1,80 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "character_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeCharacter(void* buffer, CharacterPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the character
+	serialCopy(&buffer, &packet->characterIndex, sizeof(int));
+	serialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	serialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//the owner
+	serialCopy(&buffer, &packet->accountIndex, sizeof(int));
+
+	//location
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+
+	serialCopy(&buffer, &packet->origin.x, sizeof(double));
+	serialCopy(&buffer, &packet->origin.y, sizeof(double));
+
+	serialCopy(&buffer, &packet->motion.x, sizeof(double));
+	serialCopy(&buffer, &packet->motion.y, sizeof(double));
+
+	serialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+	//gameplay components: equipment, items, buffs, debuffs...
+}
+
+void deserializeCharacter(void* buffer, CharacterPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the character
+	deserialCopy(&buffer, &packet->characterIndex, sizeof(int));
+	deserialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//the owner
+	deserialCopy(&buffer, &packet->accountIndex, sizeof(int));
+
+	//location
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+
+	deserialCopy(&buffer, &packet->origin.x, sizeof(double));
+	deserialCopy(&buffer, &packet->origin.y, sizeof(double));
+
+	deserialCopy(&buffer, &packet->motion.x, sizeof(double));
+	deserialCopy(&buffer, &packet->motion.y, sizeof(double));
+
+	deserialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+	//gameplay components: equipment, items, buffs, debuffs...
+}

common/network/packet_types/character_packet.hpp

@@ -0,0 +1,46 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "bounding_box.hpp"
+#include "vector2.hpp"
+
+struct CharacterPacket : SerialPacketBase {
+	//identify the character
+	int characterIndex;
+	char handle[PACKET_STRING_SIZE];
+	char avatar[PACKET_STRING_SIZE];
+
+	//the owner
+	int accountIndex;
+
+	//location
+	int roomIndex;
+	Vector2 origin;
+	Vector2 motion;
+	BoundingBox bounds;
+};
+
+void serializeCharacter(void* buffer, CharacterPacket* packet);
+void deserializeCharacter(void* buffer, CharacterPacket* packet);

common/network/packet_types/client_packet.cpp

@@ -0,0 +1,40 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeClient(void* buffer, ClientPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	serialCopy(&buffer, &packet->clientIndex, sizeof(int));
+	serialCopy(&buffer, &packet->accountIndex, sizeof(int));
+	serialCopy(&buffer, packet->username, PACKET_STRING_SIZE);
+}
+
+void deserializeClient(void* buffer, ClientPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	deserialCopy(&buffer, &packet->clientIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->accountIndex, sizeof(int));
+	deserialCopy(&buffer, packet->username, PACKET_STRING_SIZE);
+}

common/network/packet_types/client_packet.hpp

@@ -0,0 +1,34 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+struct ClientPacket : SerialPacketBase {
+	int clientIndex;
+	int accountIndex;
+	char username[PACKET_STRING_SIZE];
+	//TODO: (3) password, auth token
+};
+
+void serializeClient(void* buffer, ClientPacket* packet);
+void deserializeClient(void* buffer, ClientPacket* packet);

common/network/packet_types/makefile

@@ -0,0 +1,28 @@
+#config
+INCLUDES+=. .. ../../gameplay ../../map ../../utilities
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs ../$(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/network/packet_types/monster_packet.cpp

@@ -0,0 +1,70 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "monster_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeMonster(void* buffer, MonsterPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the monster
+	serialCopy(&buffer, &packet->monsterIndex, sizeof(int));
+	serialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	serialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//bounds
+	serialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+
+	//location
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	serialCopy(&buffer, &packet->origin.x, sizeof(double));
+	serialCopy(&buffer, &packet->origin.y, sizeof(double));
+	serialCopy(&buffer, &packet->motion.x, sizeof(double));
+	serialCopy(&buffer, &packet->motion.y, sizeof(double));
+}
+
+void deserializeMonster(void* buffer, MonsterPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the monster
+	deserialCopy(&buffer, &packet->monsterIndex, sizeof(int));
+	deserialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//bounds
+	deserialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+
+	//location
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->origin.x, sizeof(double));
+	deserialCopy(&buffer, &packet->origin.y, sizeof(double));
+	deserialCopy(&buffer, &packet->motion.x, sizeof(double));
+	deserialCopy(&buffer, &packet->motion.y, sizeof(double));
+}

common/network/packet_types/monster_packet.hpp

@@ -0,0 +1,43 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "bounding_box.hpp"
+#include "vector2.hpp"
+
+struct MonsterPacket : SerialPacketBase {
+	//identify the monster
+	int monsterIndex;
+	char handle[PACKET_STRING_SIZE];
+	char avatar[PACKET_STRING_SIZE];
+	BoundingBox bounds;
+
+	//location
+	int roomIndex;
+	Vector2 origin;
+	Vector2 motion;
+};
+
+void serializeMonster(void* buffer, MonsterPacket* packet);
+void deserializeMonster(void* buffer, MonsterPacket* packet);

common/network/packet_types/region_packet.cpp

@@ -0,0 +1,79 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "region_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeRegion(void* buffer, RegionPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//format
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	serialCopy(&buffer, &packet->x, sizeof(int));
+	serialCopy(&buffer, &packet->y, sizeof(int));
+
+	if (packet->type != SerialPacketType::REGION_CONTENT) {
+		return;
+	}
+
+	//tiles
+	for (int i = 0; i < REGION_WIDTH; i++) {
+		for (int j = 0; j < REGION_HEIGHT; j++) {
+			for (int k = 0; k < REGION_DEPTH; k++) {
+				*reinterpret_cast<Region::type_t*>(buffer) = packet->region->GetTile(i, j, k);
+				buffer = reinterpret_cast<char*>(buffer) + sizeof(Region::type_t);
+			}
+		}
+	}
+
+	//solids
+	serialCopy(&buffer, packet->region->GetSolidBitset(), REGION_SOLID_FOOTPRINT);
+}
+
+void deserializeRegion(void* buffer, RegionPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//format
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->x, sizeof(int));
+	deserialCopy(&buffer, &packet->y, sizeof(int));
+
+	if (packet->type != SerialPacketType::REGION_CONTENT) {
+		return;
+	}
+
+	//an object to work on
+	packet->region = new Region(packet->x, packet->y);
+
+	//tiles
+	for (int i = 0; i < REGION_WIDTH; i++) {
+		for (int j = 0; j < REGION_HEIGHT; j++) {
+			for (int k = 0; k < REGION_DEPTH; k++) {
+				packet->region->SetTile(i, j, k, *reinterpret_cast<Region::type_t*>(buffer));
+				buffer = reinterpret_cast<char*>(buffer) + sizeof(Region::type_t);
+			}
+		}
+	}
+
+	//solids
+	deserialCopy(&buffer, packet->region->GetSolidBitset(), REGION_SOLID_FOOTPRINT);
+}

common/network/packet_types/region_packet.hpp

@@ -0,0 +1,45 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "region.hpp"
+
+#include <cmath>
+
+//define the memory footprint for the region's members
+constexpr int REGION_TILE_FOOTPRINT = sizeof(Region::type_t) * REGION_WIDTH * REGION_HEIGHT * REGION_DEPTH;
+constexpr int REGION_SOLID_FOOTPRINT = ceil(REGION_WIDTH * REGION_HEIGHT / 8.0);
+constexpr int REGION_METADATA_FOOTPRINT = sizeof(int) * 3;
+
+struct RegionPacket : SerialPacketBase {
+	//location/identify the region
+	int roomIndex;
+	int x, y;
+
+	//the data
+	Region* region;
+};
+
+void serializeRegion(void* buffer, RegionPacket* packet);
+void deserializeRegion(void* buffer, RegionPacket* packet);

common/network/packet_types/serial_packet_base.cpp

@@ -0,0 +1,24 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "serial_packet_base.hpp"
+
+//sanity check

common/network/packet_types/serial_packet_base.hpp

@@ -0,0 +1,36 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_type.hpp"
+
+#include "SDL2/SDL_net.h"
+
+constexpr int PACKET_STRING_SIZE = 100;
+
+struct SerialPacketBase {
+	//members
+	SerialPacketType type;
+	IPaddress srcAddress;
+
+	virtual ~SerialPacketBase() {};
+};

common/network/packet_types/server_packet.cpp

@@ -0,0 +1,42 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "server_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeServer(void* buffer, ServerPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the server
+	serialCopy(&buffer, &packet->version, sizeof(int));
+	serialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	serialCopy(&buffer, &packet->playerCount, sizeof(int));
+}
+
+void deserializeServer(void* buffer, ServerPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the server
+	deserialCopy(&buffer, &packet->version, sizeof(int));
+	deserialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, &packet->playerCount, sizeof(int));
+}

common/network/packet_types/server_packet.hpp

@@ -0,0 +1,34 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+struct ServerPacket : SerialPacketBase {
+	//identify the server
+	char name[PACKET_STRING_SIZE];
+	int playerCount;
+	int version;
+};
+
+void serializeServer(void* buffer, ServerPacket* packet);
+void deserializeServer(void* buffer, ServerPacket* packet);

common/network/packet_types/text_packet.cpp

@@ -0,0 +1,52 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "text_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeText(void* buffer, TextPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//content
+	serialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	serialCopy(&buffer, packet->text, PACKET_STRING_SIZE);
+
+	//location
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	serialCopy(&buffer, &packet->origin.x, sizeof(double));
+	serialCopy(&buffer, &packet->origin.y, sizeof(double));
+	serialCopy(&buffer, &packet->range, sizeof(int));
+}
+
+void deserializeText(void* buffer, TextPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//content
+	deserialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, packet->text, PACKET_STRING_SIZE);
+
+	//location
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->origin.x, sizeof(double));
+	deserialCopy(&buffer, &packet->origin.y, sizeof(double));
+	deserialCopy(&buffer, &packet->range, sizeof(int));
+}

common/network/packet_types/text_packet.hpp

@@ -0,0 +1,37 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "vector2.hpp"
+
+struct TextPacket : SerialPacketBase {
+	char name[PACKET_STRING_SIZE];
+	char text[PACKET_STRING_SIZE];
+	int roomIndex;
+	Vector2 origin;
+	int range;
+};
+
+void serializeText(void* buffer, TextPacket* packet);
+void deserializeText(void* buffer, TextPacket* packet);

common/network/serial_packet.hpp

@@ -0,0 +1,63 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+#include "character_packet.hpp"
+#include "client_packet.hpp"
+#include "monster_packet.hpp"
+#include "region_packet.hpp"
+#include "server_packet.hpp"
+#include "text_packet.hpp"
+
+//SerialPacketBase is defined in serial_packet_base.hpp
+typedef SerialPacketBase SerialPacket;
+
+//DOCS: NETWORK_VERSION is used to discern compatible servers and clients
+constexpr int NETWORK_VERSION = 20160316;
+
+union MaxPacket {
+	CharacterPacket a;
+	ClientPacket b;
+	MonsterPacket c;
+	RegionPacket d;
+	ServerPacket e;
+	TextPacket f;
+};
+
+constexpr int MAX_PACKET_SIZE = sizeof(MaxPacket);
+
+/* DOCS: PACKET_BUFFER_SIZE is the memory required to store serialized data
+ * DOCS: SerialPacketType::REGION_CONTENT is currently the largest packet type
+ * Serialized RegionPacket structure:
+ *     SerialPacketType
+ *     room index (int)
+ *     X & Y position (int)
+ *     tile data (3 layers)
+ *     solid data (bitset)
+*/
+
+constexpr int PACKET_BUFFER_SIZE =
+	sizeof(SerialPacketType) +
+	REGION_METADATA_FOOTPRINT +
+	REGION_TILE_FOOTPRINT +
+	REGION_SOLID_FOOTPRINT;

common/network/serial_packet_type.hpp

@@ -0,0 +1,184 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+/* DOCS: The headers indicate what packet type is used for each message
+ * different messages under the same header will carry different amounts of
+ * valid data, but it will still be carried in that packet's format.
+ * FORMAT_* is for internal use, deviding the different format bounds.
+*/
+
+enum class SerialPacketType {
+	//default: there is something wrong
+	NONE,
+
+	//-------------------------
+	//ServerPacket
+	//  name, player count, version
+	//-------------------------
+
+	FORMAT_SERVER,
+
+	//heartbeat
+	PING,
+	PONG,
+
+	//Used for finding available servers
+	BROADCAST_REQUEST,
+	BROADCAST_RESPONSE,
+
+	FORMAT_END_SERVER,
+
+	//-------------------------
+	//ClientPacket
+	//  client index, account index, username
+	//-------------------------
+
+	FORMAT_CLIENT,
+
+	//Connecting to a server as a client
+	JOIN_REQUEST,
+	JOIN_RESPONSE,
+
+	//disconnect from the server
+	DISCONNECT_REQUEST,
+	DISCONNECT_RESPONSE,
+	ADMIN_DISCONNECT_FORCED,
+
+	//load the account
+	LOGIN_REQUEST,
+	LOGIN_RESPONSE,
+
+	//unload the account
+	LOGOUT_REQUEST,
+	LOGOUT_RESPONSE,
+
+	//shut down the server
+	ADMIN_SHUTDOWN_REQUEST,
+
+	FORMAT_END_CLIENT,
+
+	//-------------------------
+	//RegionPacket
+	//  room index, x, y, raw data
+	//-------------------------
+
+	FORMAT_REGION,
+
+	//map data
+	REGION_REQUEST,
+	REGION_CONTENT,
+
+	FORMAT_END_REGION,
+
+	//-------------------------
+	//CharacterPacket
+	//  character index,
+	//  handle, avatar,
+	//  account index (owner),
+	//  room index, origin, motion
+	//-------------------------
+
+	FORMAT_CHARACTER,
+
+	//full data update
+	CHARACTER_UPDATE,
+
+	//character management
+	CHARACTER_CREATE,
+	CHARACTER_DELETE,
+	CHARACTER_LOAD,
+	CHARACTER_UNLOAD,
+
+	//find out info from the server
+	QUERY_CHARACTER_EXISTS,
+	QUERY_CHARACTER_STATS,
+	QUERY_CHARACTER_LOCATION,
+
+	//actions taken
+	CHARACTER_MOVEMENT,
+	CHARACTER_ATTACK,
+	CHARACTER_DAMAGE,
+
+	//admin control
+//	ADMIN_SET_CHARACTER_ORIGIN,
+
+	FORMAT_END_CHARACTER,
+
+	//-------------------------
+	//MonsterPacket
+	//  monster index,
+	//  handle, avatar
+	//  bounds
+	//  room index, origin, motion
+	//-------------------------
+
+	FORMAT_MONSTER,
+
+	//full data update
+	MONSTER_UPDATE,
+
+	//character management
+	MONSTER_CREATE,
+	MONSTER_DELETE,
+
+	//find out info from the server
+	QUERY_MONSTER_EXISTS,
+	QUERY_MONSTER_STATS,
+	QUERY_MONSTER_LOCATION,
+
+	//actions taken
+	MONSTER_MOVEMENT,
+	MONSTER_ATTACK,
+	MONSTER_DAMAGE,
+
+	FORMAT_END_MONSTER,
+
+	//-------------------------
+	//TextPacket
+	//  name, text
+	//-------------------------
+
+	FORMAT_TEXT,
+
+	//general speech
+	TEXT_BROADCAST,
+	TEXT_SPEECH,
+	TEXT_WHISPER,
+
+	//rejection/error messages
+	JOIN_REJECTION,
+	LOGIN_REJECTION,
+	REGION_REJECTION,
+	CHARACTER_REJECTION,
+	MONSTER_REJECTION,
+	SHUTDOWN_REJECTION,
+	QUERY_REJECTION,
+
+	FORMAT_END_TEXT,
+
+	//-------------------------
+	//not used
+	//-------------------------
+
+	LAST
+};

common/network/serial_utility.cpp

@@ -0,0 +1,105 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "serial_utility.hpp"
+
+//packet types
+#include "character_packet.hpp"
+#include "client_packet.hpp"
+#include "monster_packet.hpp"
+#include "region_packet.hpp"
+#include "server_packet.hpp"
+#include "text_packet.hpp"
+
+#include <cstring>
+
+//macros
+#define BOUNDS(type, lower, upper) ((type) > (lower) && (type) < (upper))
+
+//raw memory copy
+void serialCopy(void** buffer, void* data, int size) {
+	memcpy(*buffer, data, size);
+	*buffer = reinterpret_cast<char*>(*buffer) + size;
+}
+
+void deserialCopy(void** buffer, void* data, int size) {
+	memcpy(data, *buffer, 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) {
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_SERVER, SerialPacketType::FORMAT_END_SERVER)) {
+		serializeServer(buffer, static_cast<ServerPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_CLIENT, SerialPacketType::FORMAT_END_CLIENT)) {
+		serializeClient(buffer, static_cast<ClientPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_REGION, SerialPacketType::FORMAT_END_REGION)) {
+		serializeRegion(buffer, static_cast<RegionPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_CHARACTER, SerialPacketType::FORMAT_END_CHARACTER)) {
+		serializeCharacter(buffer, static_cast<CharacterPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_MONSTER, SerialPacketType::FORMAT_END_MONSTER)) {
+		serializeMonster(buffer, static_cast<MonsterPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_TEXT, SerialPacketType::FORMAT_END_TEXT)) {
+		serializeText(buffer, static_cast<TextPacket*>(packet));
+	}
+}
+
+void deserializePacket(void* buffer, SerialPacketBase* packet) {
+	//find the type, so that you can actually deserialize the packet!
+	SerialPacketType type;
+	memcpy(&type, buffer, sizeof(SerialPacketType));
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_SERVER, SerialPacketType::FORMAT_END_SERVER)) {
+		deserializeServer(buffer, static_cast<ServerPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_CLIENT, SerialPacketType::FORMAT_END_CLIENT)) {
+		deserializeClient(buffer, static_cast<ClientPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_REGION, SerialPacketType::FORMAT_END_REGION)) {
+		deserializeRegion(buffer, static_cast<RegionPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_CHARACTER, SerialPacketType::FORMAT_END_CHARACTER)) {
+		deserializeCharacter(buffer, static_cast<CharacterPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_MONSTER, SerialPacketType::FORMAT_END_MONSTER)) {
+		deserializeMonster(buffer, static_cast<MonsterPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_TEXT, SerialPacketType::FORMAT_END_TEXT)) {
+		deserializeText(buffer, static_cast<TextPacket*>(packet));
+	}
+}

common/network/serial_utility.hpp

@@ -0,0 +1,34 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include <cstring>
+
+//raw memory copy
+void serialCopy(void** buffer, void* data, int size);
+void deserialCopy(void** buffer, void* data, int size);
+
+//primary functions
+void serializePacket(void* buffer, SerialPacketBase* packet);
+void deserializePacket(void* buffer, SerialPacketBase* packet);

common/network/udp_network_utility.cpp

@@ -0,0 +1,224 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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 "udp_network_utility.hpp"
+
+#include "serial_packet.hpp"
+#include "serial_utility.hpp"
+
+#include <stdexcept>
+
+//DOCS: memset() is used before sending a packet to remove old data; you don't want to send sensitive data over the network
+//NOTE: don't confuse SerialPacketBase with UDPpacket
+
+void UDPNetworkUtility::Open(int port) {
+	socket = SDLNet_UDP_Open(port);
+	packet = SDLNet_AllocPacket(PACKET_BUFFER_SIZE);
+	if (!socket || !packet) {
+		Close();
+		throw(std::runtime_error("Failed to open UDPNetworkUtility"));
+	}
+}
+
+void UDPNetworkUtility::Close() {
+	SDLNet_UDP_Close(socket);
+	SDLNet_FreePacket(packet);
+	socket = nullptr;
+	packet = nullptr;
+}
+
+//-------------------------
+//bind to a channel
+//-------------------------
+
+int UDPNetworkUtility::Bind(const char* ip, int port, int channel) {
+	IPaddress add;
+	if (SDLNet_ResolveHost(&add, ip, port) == -1) {
+		throw(std::runtime_error("Failed to resolve a host"));
+	}
+
+	return Bind(add, channel);
+}
+
+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"));
+	}
+
+	return ret;
+}
+
+void UDPNetworkUtility::Unbind(int channel) {
+	SDLNet_UDP_Unbind(socket, channel);
+}
+
+//-------------------------
+//send a buffer
+//-------------------------
+
+int UDPNetworkUtility::SendTo(const char* ip, int port, void* data, int len) {
+	IPaddress add;
+	if (SDLNet_ResolveHost(&add, ip, port) == -1) {
+		throw(std::runtime_error("Failed to resolve a host"));
+	}
+
+	SendTo(add, data, 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;
+
+	int ret = SDLNet_UDP_Send(socket, -1, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendTo(int channel, 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;
+
+	int ret = SDLNet_UDP_Send(socket, channel, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendToAllChannels(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;
+
+	int sent = 0;
+
+	//send to all bound channels
+	for (int i = 0; i < SDLNET_MAX_UDPCHANNELS; i++) {
+		if (SDLNet_UDP_GetPeerAddress(socket, i)) {
+			sent += SDLNet_UDP_Send(socket, i, packet);
+		}
+	}
+
+	return sent;
+}
+
+int UDPNetworkUtility::Receive() {
+	memset(packet->data, 0, packet->maxlen);
+	int ret = SDLNet_UDP_Recv(socket, packet);
+
+	if (ret < 0) {
+		throw(std::runtime_error("Unknown network error occured"));
+	}
+
+	return ret;
+}
+
+//-------------------------
+//send a SerialPacketBase
+//-------------------------
+
+int UDPNetworkUtility::SendTo(const char* ip, int port, SerialPacketBase* serialPacket) {
+	IPaddress add;
+	if (SDLNet_ResolveHost(&add, ip, port) == -1) {
+		throw(std::runtime_error("Failed to resolve a host"));
+	}
+
+	SendTo(add, 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;
+
+	int ret = SDLNet_UDP_Send(socket, -1, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendTo(int channel, SerialPacketBase* serialPacket) {
+	memset(packet->data, 0, packet->maxlen);
+	serializePacket(packet->data, serialPacket);
+	packet->len = PACKET_BUFFER_SIZE;
+
+	int ret = SDLNet_UDP_Send(socket, channel, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendToAllChannels(SerialPacketBase* serialPacket) {
+	memset(packet->data, 0, packet->maxlen);
+	serializePacket(packet->data, serialPacket);
+	packet->len = PACKET_BUFFER_SIZE;
+
+	int sent = 0;
+
+	//send to all bound channels
+	for (int i = 0; i < SDLNET_MAX_UDPCHANNELS; i++) {
+		if (SDLNet_UDP_GetPeerAddress(socket, i)) {
+			sent += SDLNet_UDP_Send(socket, i, packet);
+		}
+	}
+
+	return sent;
+}
+
+int UDPNetworkUtility::Receive(SerialPacketBase* serialPacket) {
+	memset(packet->data, 0, packet->maxlen);
+	int ret = SDLNet_UDP_Recv(socket, packet);
+	deserializePacket(packet->data, serialPacket);
+	serialPacket->srcAddress = packet->address;
+
+	if (ret < 0) {
+		throw(std::runtime_error("Unknown network error occured"));
+	}
+
+	return ret;
+}

common/network/udp_network_utility.hpp

@@ -0,0 +1,74 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * 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.
+*/
+#pragma once
+
+//common
+#include "serial_packet_base.hpp"
+#include "singleton.hpp"
+
+//APIs
+#include "SDL2/SDL_net.h"
+
+class UDPNetworkUtility : public Singleton<UDPNetworkUtility> {
+public:
+	void Open(int port);
+	void Close();
+
+	//bind to a channel
+	int Bind(const char* ip, int port, int channel = -1);
+	int Bind(IPaddress add, int channel = -1);
+	void Unbind(int channel);
+
+	IPaddress* GetIPAddress(int channel) {
+		return SDLNet_UDP_GetPeerAddress(socket, channel);
+	}
+
+	//send a buffer
+	int SendTo(const char* ip, int port, 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(int channel, SerialPacketBase* serialPacket);
+	int SendToAllChannels(SerialPacketBase* serialPacket);
+	int Receive(SerialPacketBase* serialPacket);
+
+	//accessors
+	UDPpacket* GetPacket() const {
+		return packet;
+	}
+	UDPsocket GetSocket() const {
+		return socket;
+	}
+private:
+	friend Singleton<UDPNetworkUtility>;
+
+	UDPNetworkUtility() = default;
+	~UDPNetworkUtility() = default;
+
+	UDPsocket socket = nullptr;
+	UDPpacket* packet = nullptr;
+};