refactor io

.github/workflows/ubuntu.yml

@@ -1,31 +0,0 @@
-name: Linux arm64
-run-name: Build And Test
-
-on: [push]
-
-
-env:
-  XMAKE_ROOT: y
-
-jobs:
-  Build:
-    runs-on: ubuntu-latest
-    steps: 
-      - name: Check out repository code
-        uses: actions/checkout@v3
-
-      - name: Prepare XMake
-        uses: xmake-io/github-action-setup-xmake@v1
-        with:
-          xmake-version: latest
-          actions-cache-folder: '.xmake-cache'
-          actions-cache-key: 'ubuntu'
-      
-      - name: XMake config
-        run: xmake f -p linux -y
-
-      - name: Build
-        run: xmake
-
-      - name: Test
-        run: xmake test

include/sp/common/DataBuffer.h

@@ -166,7 +166,7 @@ class DataBuffer {
 			K newKey;
 			V newValue;
 			*this >> newKey >> newValue;
-			data.emplace(newKey, newValue);
+			data.insert({newKey, newValue});
 		}
 		return *this;
 	}

include/sp/common/VarInt.h

@@ -21,8 +21,6 @@ class VarInt {
 	std::uint64_t m_Value;
 
   public:
-	static const std::uint64_t MAX_VALUE = static_cast<std::uint64_t>(-1) >> 8;
-
 	VarInt() : m_Value(0) {}
 	/**
 	 * \brief Construct a variable integer from a value

include/sp/extensions/Compress.h

@@ -8,19 +8,6 @@
 #include <cstdint>
 #include <sp/common/DataBuffer.h>
 
-namespace sp {
-namespace option {
-
-struct ZlibCompress {
-	bool m_Enabled = true;
-	std::size_t m_CompressionThreshold = 64;
-};
-
-}  // namespace option
-}  // namespace sp
-
-#include <sp/io/IOInterface.h>
-
 namespace sp {
 namespace zlib {
 
@@ -29,7 +16,14 @@ namespace zlib {
  * \param buffer the data to compress
  * \return the compressed data
  */
-DataBuffer Compress(const DataBuffer& buffer, std::size_t a_CompressionThreshold = 64);
+DataBuffer Compress(const DataBuffer& buffer);
+
+/**
+ * \brief Reads the packet lenght and uncompress it
+ * \param buffer the data to uncompress
+ * \return the uncompressed data
+ */
+DataBuffer Decompress(DataBuffer& buffer);
 
 /**
  * \brief Uncompress some data
@@ -40,15 +34,4 @@ DataBuffer Compress(const DataBuffer& buffer, std::size_t a_CompressionThreshold
 DataBuffer Decompress(DataBuffer& buffer, std::uint64_t packetLength);
 
 }  // namespace zlib
-
-namespace io {
-
-template <>
-class MessageEncapsulator<option::ZlibCompress> {
-  public:
-	static DataBuffer Encapsulate(const DataBuffer& a_Data, const option::ZlibCompress& a_Option);
-	static DataBuffer Decapsulate(DataBuffer& a_Data, const option::ZlibCompress& a_Option);
-};
-
-}  // namespace io
 }  // namespace sp

include/sp/extensions/Encrypt.h

@@ -1,41 +0,0 @@
-#pragma once
-
-/**
- * \file Encrypt.h
- * \brief File containing encrypt utilities
- */
-
-#include <sp/common/DataBuffer.h>
-
-namespace sp {
-namespace option {
-
-struct TlsEncrypt {
-	bool m_Enabled = true;
-};
-
-}  // namespace option
-}  // namespace sp
-
-#include <sp/io/IOInterface.h>
-
-namespace sp {
-namespace ssl {
-
-// encrypt
-
-// decrypt
-
-}  // namespace ssl
-
-namespace io {
-
-template <>
-class MessageEncapsulator<option::TlsEncrypt> {
-  public:
-	static DataBuffer Encapsulate(const DataBuffer& a_Data, const option::TlsEncrypt& a_Option);
-	static DataBuffer Decapsulate(DataBuffer& a_Data, const option::TlsEncrypt& a_Option);
-};
-
-}  // namespace io
-}  // namespace sp

include/sp/io/IOInterface.h

@@ -13,43 +13,26 @@ class IOInterface {
 	void Write(const DataBuffer& a_Data);
 };
 
-template <typename TOption>
-class MessageEncapsulator {
-  public:
-	static DataBuffer Encapsulate(const DataBuffer& a_Data, const TOption& a_Option);
-	static DataBuffer Decapsulate(DataBuffer& a_Data, const TOption& a_Option);
-};
-
-template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
+template <typename IOTag, typename MessageDispatcher, typename MessageFactory>
 class Stream {
   protected:
 	MessageDispatcher m_Dispatcher;
 	IOInterface<IOTag> m_Interface;
-	std::tuple<TOptions...> m_Options;
 
 	using MessageBase = typename MessageDispatcher::MessageBaseType;
+	using MsgIdType = typename MessageBase::MsgIdType;
 
   public:
 	Stream() {}
-	Stream(IOInterface<IOTag>&& a_Interface, TOptions&&... a_Options);
-	Stream(Stream&& a_Stream);
+	Stream(IOInterface<IOTag>&& a_Interface) : m_Interface(std::move(a_Interface)) {}
+	Stream(Stream&& a_Stream) : m_Dispatcher(std::move(a_Stream.m_Dispatcher)), m_Interface(std::move(a_Stream.m_Interface)) {}
 
 	void RecieveMessages();
 	void SendMessage(const MessageBase& a_Message);
 
-
-	template <typename TOption>
-	TOption& GetOption() {
-		return std::get<TOption>(m_Options);
-	}
-
 	MessageDispatcher& GetDispatcher() {
 		return m_Dispatcher;
 	}
-
-  private:
-	static DataBuffer Encapsulate(const DataBuffer& a_Data, const TOptions&... a_Options);
-	static DataBuffer Decapsulate(DataBuffer& a_Data, const TOptions&... a_Options);
 };
 
 }  // namespace io

include/sp/io/IOInterfaceImpl.inl

@@ -1,64 +1,23 @@
 #pragma once
 
-#include <sp/extensions/Compress.h>
 #include <stdexcept>
 
 namespace sp {
-
-namespace details {
-
-template <typename... TOptions>
-struct MessageEncapsulatorPack {};
-
-template <>
-struct MessageEncapsulatorPack<> {
-	static DataBuffer Encapsulate(const DataBuffer& a_Data) {
-		return a_Data;
-	}
-	static DataBuffer Decapsulate(DataBuffer& a_Data) {
-		return a_Data;
-	}
-};
-
-template <typename TOption, typename... TOptions>
-struct MessageEncapsulatorPack<TOption, TOptions...> {
-	static DataBuffer Encapsulate(const DataBuffer& a_Data, const TOption& a_Option, const TOptions&... a_Options) {
-		DataBuffer data = io::MessageEncapsulator<TOption>::Encapsulate(a_Data, a_Option);
-		return MessageEncapsulatorPack<TOptions...>::Encapsulate(data, a_Options...);
-	}
-	static DataBuffer Decapsulate(DataBuffer& a_Data, const TOption& a_Option, const TOptions&... a_Options) {
-		DataBuffer data = io::MessageEncapsulator<TOption>::Decapsulate(a_Data, a_Option);
-		return MessageEncapsulatorPack<TOptions...>::Decapsulate(data, a_Options...);
-	}
-};
-
-}  // namespace details
-
 namespace io {
 
-template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
-Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Stream(IOInterface<IOTag>&& a_Interface, TOptions&&... a_Options) :
-	m_Interface(std::move(a_Interface)), m_Options(std::make_tuple<TOptions...>(std::move(a_Options)...)) {}
-
-template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
-Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Stream(
-	Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>&& a_Stream) :
-	m_Dispatcher(std::move(a_Stream.m_Dispatcher)), m_Interface(std::move(a_Stream.m_Interface)) {}
-
-template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
-void Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::SendMessage(const MessageBase& a_Message) {
+template <typename IOTag, typename MessageDispatcher, typename MessageFactory>
+void Stream<IOTag, MessageDispatcher, MessageFactory>::SendMessage(const MessageBase& a_Message) {
+	// TODO: process compress + encryption
 	DataBuffer data = a_Message.Write();
-	DataBuffer encapsulated = std::apply([&data](const auto&... a_Options) {
-		return Encapsulate(data, a_Options...);
-	}, m_Options);
-	DataBuffer finalData;
-	finalData << VarInt{encapsulated.GetSize()} << encapsulated;
-	m_Interface.Write(finalData);
+	DataBuffer dataSize;
+	m_Interface.Write(dataSize << sp::VarInt{data.GetSize()} << data);
 }
 
-template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
-void Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::RecieveMessages() {
+template <typename IOTag, typename MessageDispatcher, typename MessageFactory>
+void Stream<IOTag, MessageDispatcher, MessageFactory>::RecieveMessages() {
+	// TODO: process compress + encryption
 	while (true) {
+
 		// reading the first VarInt part byte by byte
 		std::uint64_t lenghtValue = 0;
 		unsigned int readPos = 0;
@@ -93,16 +52,14 @@ void Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::RecieveMessa
 		DataBuffer buffer;
 		buffer = m_Interface.Read(lenghtValue);
 
-		buffer = std::apply([&buffer, lenghtValue](const auto&... a_Options) {
-			return Decapsulate(buffer, a_Options...);
-		}, m_Options);
+		// TODO: process compress + encryption
 
-		VarInt packetType;
+		MsgIdType packetType;
 		buffer >> packetType;
 
 		static const MessageFactory messageFactory;
 
-		std::unique_ptr<MessageBase> message = messageFactory.CreateMessage(packetType.GetValue());
+		std::unique_ptr<MessageBase> message = messageFactory.CreateMessage(packetType);
 
 		assert(message != nullptr);
 
@@ -112,17 +69,5 @@ void Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::RecieveMessa
 	}
 }
 
-template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
-DataBuffer Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Encapsulate(
-	const DataBuffer& a_Data, const TOptions&... a_Options) {
-	return details::MessageEncapsulatorPack<TOptions...>::Encapsulate(a_Data, a_Options...);
-}
-
-template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
-DataBuffer Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Decapsulate(
-	DataBuffer& a_Data, const TOptions&... a_Options) {
-	return details::MessageEncapsulatorPack<TOptions...>::Decapsulate(a_Data, a_Options...);
-}
-
 }  // namespace io
 }  // namespace sp

include/sp/protocol/MessageFactory.h

@@ -5,10 +5,10 @@
 #include <iostream>
 #include <memory>
 
-#include <sp/protocol/message/ArrayFillerImpl.h>
-
 namespace sp {
 
+#include <sp/protocol/message/ArrayFillerImpl.inl>
+
 template <typename TBase, typename TTMessages>
 class MessageFactory {
   public:

include/sp/protocol/message/ArrayFillerImpl.inl

@@ -1,12 +1,12 @@
 #pragma once
 
-namespace sp {
 namespace details {
 
 template <typename TBase>
 using ArrayType = std::vector<std::function<std::unique_ptr<TBase>(void)>>;
 
 
+
 template <typename TBase, typename... TMessages>
 struct ArrayFiller {};
 
@@ -35,5 +35,4 @@ struct ArrayFiller<TBase, TMessage> {
 	}
 };
 
-}  // namespace details
-}  // namespace sp
+}  // namespace details

include/sp/protocol/message/MessageInterfacesImpl.h

@@ -117,7 +117,7 @@ template <typename TBase>
 class MessageInterfaceWriteIdBase : public TBase {
   public:
 	void Write(DataBuffer& buffer) const {
-		buffer << VarInt{this->GetId()};
+		this->WriteData(this->GetId(), buffer);
 		this->WriteImpl(buffer);
 	}
 

src/sp/extensions/Compress.cpp

@@ -4,6 +4,8 @@
 #include <sp/common/VarInt.h>
 #include <zlib.h>
 
+#define COMPRESSION_THRESHOLD 64
+
 namespace sp {
 namespace zlib {
 
@@ -11,8 +13,8 @@ static DataBuffer Inflate(const std::uint8_t* source, std::size_t size, std::siz
 	DataBuffer result;
 	result.Resize(uncompressedSize);
 
-	uncompress(static_cast<Bytef*>(result.data()), static_cast<uLongf*>(&uncompressedSize), static_cast<const Bytef*>(source),
-		static_cast<uLong>(size));
+	uncompress(reinterpret_cast<Bytef*>(result.data()), reinterpret_cast<uLongf*>(&uncompressedSize),
+		reinterpret_cast<const Bytef*>(source), static_cast<uLong>(size));
 
 	assert(result.GetSize() == uncompressedSize);
 	return result;
@@ -23,34 +25,35 @@ static DataBuffer Deflate(const std::uint8_t* source, std::size_t size) {
 	uLongf compressedSize = size;
 
 	result.Resize(size);  // Resize for the compressed data to fit into
-	compress(static_cast<Bytef*>(result.data()), &compressedSize, static_cast<const Bytef*>(source), static_cast<uLong>(size));
+	compress(
+		reinterpret_cast<Bytef*>(result.data()), &compressedSize, reinterpret_cast<const Bytef*>(source), static_cast<uLong>(size));
 	result.Resize(compressedSize);	// Resize to cut useless data
 
 	return result;
 }
 
-DataBuffer Compress(const DataBuffer& buffer, std::size_t a_CompressionThreshold) {
+DataBuffer Compress(const DataBuffer& buffer) {
 	DataBuffer packet;
 
-	if (buffer.GetSize() < a_CompressionThreshold) {
+	if (buffer.GetSize() < COMPRESSION_THRESHOLD) {
 		// Don't compress since it's a small packet
-		packet << VarInt{0};
+		VarInt compressedDataLength = 0;
+		std::uint64_t packetLength = compressedDataLength.GetSerializedLength() + buffer.GetSize();
+
+		packet << packetLength;
+		packet << compressedDataLength;
 		packet << buffer;
 		return packet;
 	}
 
 	DataBuffer compressedData = Deflate(buffer.data(), buffer.GetSize());
+
 	VarInt uncompressedDataLength = buffer.GetSize();
+	std::uint64_t packetLength = uncompressedDataLength.GetSerializedLength() + compressedData.GetSize();
 
-	if (compressedData.GetSize() >= buffer.GetSize()) {
-		// the compression is overkill so we don't send the compressed buffer
-		packet << VarInt{0};
-		packet << buffer;
-	} else {
-		packet << uncompressedDataLength;
-		packet << compressedData;
-	}
-
+	packet << packetLength;
+	packet << uncompressedDataLength;
+	packet.WriteSome(compressedData.data(), compressedData.GetSize());
 	return packet;
 }
 
@@ -72,18 +75,12 @@ DataBuffer Decompress(DataBuffer& buffer, std::uint64_t packetLength) {
 	return Inflate(buffer.data() + buffer.GetReadOffset(), compressedLength, uncompressedLength.GetValue());
 }
 
+DataBuffer Decompress(DataBuffer& buffer) {
+	std::uint64_t packetLength;
+	buffer >> packetLength;
+
+	return Decompress(buffer, packetLength);
+}
+
 }  // namespace zlib
-
-namespace io {
-
-DataBuffer MessageEncapsulator<option::ZlibCompress>::Encapsulate(const DataBuffer& a_Data, const option::ZlibCompress& a_Option) {
-	static constexpr std::size_t MAX_COMPRESS_THRESHOLD = VarInt::MAX_VALUE;
-	return zlib::Compress(a_Data, a_Option.m_Enabled ? a_Option.m_CompressionThreshold : MAX_COMPRESS_THRESHOLD);
-}
-
-DataBuffer MessageEncapsulator<option::ZlibCompress>::Decapsulate(DataBuffer& a_Data, const option::ZlibCompress& a_Option) {
-	return zlib::Decompress(a_Data, a_Data.GetSize());
-}
-
-}  // namespace io
 }  // namespace sp

src/sp/extensions/Encrypt.cpp

@@ -1,3 +0,0 @@
-#include <sp/extensions/Encrypt.h>
-
-#include <openssl/ssl.h>

test/test_file.cpp

@@ -17,24 +17,18 @@ class CustomPacketHandler : public sp::PacketHandler {
 	}
 };
 
-using FileStream = sp::io::Stream<sp::io::FileTag, sp::PacketDispatcher, sp::PacketFactory, sp::option::ZlibCompress>;
+using FileStream = sp::io::Stream<sp::io::FileTag, sp::PacketDispatcher, sp::PacketFactory>;
 
 int main() {
 	auto handler = std::make_shared<CustomPacketHandler>();
 
-	FileStream stream(sp::io::File{"test.txt", sp::io::FileTag::In | sp::io::FileTag::Out}, {});
+	FileStream stream(sp::io::File{"test.txt", sp::io::FileTag::In | sp::io::FileTag::Out});
 	stream.GetDispatcher().RegisterHandler(PacketId::Disconnect, handler);
 	stream.GetDispatcher().RegisterHandler(PacketId::KeepAlive, handler);
 
 	stream.SendMessage(KeepAlivePacket{96});
 	stream.SendMessage(KeepAlivePacket{69});
-	stream.SendMessage(DisconnectPacket{
-		"This is in the "
-		"fiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiile !"});
-	stream.GetOption<sp::option::ZlibCompress>().m_Enabled = false;
-	stream.SendMessage(DisconnectPacket{
-		"This is in the "
-		"fiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiile !"});
+	stream.SendMessage(DisconnectPacket{"This is in the file !"});
 
 	stream.RecieveMessages();
 

test/test_io.cpp

@@ -33,7 +33,7 @@ int main() {
 
 	stream.SendMessage(KeepAlivePacket{69});
 	stream.RecieveMessages();
-	stream.SendMessage(DisconnectPacket{"A valid reason"});
+	stream.SendMessage(DisconnectPacket{"I don't know"});
 	stream.RecieveMessages();
 
 	return 0;

xmake.lua

@@ -6,14 +6,9 @@ local modules = {
     Compression = {
         Option = "zlib",
         Deps = {"zlib"},
+        Packages = {"zlib"},
         Includes = {"include/(sp/extensions/Compress.h)"},
         Sources = {"src/sp/extensions/Compress.cpp"}
-    },
-    Encryption = {
-        Option = "ssl",
-        Deps = {"openssl"},
-        Includes = {"include/(sp/extensions/Encrypt.h)"},
-        Sources = {"src/sp/extensions/Encrypt.cpp"}
     }
 }
 
@@ -34,7 +29,7 @@ end
 -- Add modules targets
 for name, module in table.orderpairs(modules) do
 	if module.Deps and has_config(module.Option) then
-        target("SimpleProtocol-" .. name)
+        target("SimpleProtocolLib-" .. name)
             add_includedirs("include")
             for _, include in table.orderpairs(module.Includes) do
                 add_headerfiles(include)
@@ -42,7 +37,7 @@ for name, module in table.orderpairs(modules) do
             for _, source in table.orderpairs(module.Sources) do
                 add_files(source)
             end
-            for _, package in table.orderpairs(module.Deps) do
+            for _, package in table.orderpairs(module.Packages) do
                 add_packages(package)
             end
             set_group("Library")
@@ -50,7 +45,7 @@ for name, module in table.orderpairs(modules) do
     end
 end
 
-target("SimpleProtocol")
+target("SimpleProtocolLib")
     add_includedirs("include")
     add_files("src/sp/**.cpp")
     
@@ -59,13 +54,6 @@ target("SimpleProtocol")
         add_headerfiles("include/(sp/" .. folder .. "/**.h)")
     end
 
-    -- adding extensions
-    for name, module in table.orderpairs(modules) do
-	    if module.Deps and has_config(module.Option) then
-            add_deps("SimpleProtocol-" .. name)
-        end
-    end
-
     -- we don't want extensions
     remove_files("src/sp/extensions/**.cpp")
     set_group("Library")
@@ -80,7 +68,7 @@ for _, file in ipairs(os.files("test/**.cpp")) do
         add_files(file)
         add_includedirs("include")
 
-        add_deps("SimpleProtocol")
+        add_deps("SimpleProtocolLib")
 
         add_tests("compile_and_run")
 end