docs: finished low level lib docs and client tcp/udp

Author: EnergyCube

include/Polymorph/Network/Packet.hpp

@@ -23,6 +23,11 @@ namespace polymorph::network
     struct Packet
     {
         PacketHeader header;
+
+        /**
+         * @property The packet payload, contains the data to send
+         * @tparam T The type of the payload
+         */
         T payload;
     }
 #ifdef _WIN32

include/Polymorph/Network/PacketHeader.hpp

@@ -22,9 +22,24 @@ namespace polymorph::network
 #endif
     struct PacketHeader
     {
+        /**
+         * @property The packet operation code, used to identify the packet action
+         */
         OpId opId;
+
+        /**
+         * @property The packet identifier, used to uniquely identify a packet (in a short time)
+         */
         PacketId pId;
+
+        /**
+         * @property The session identifier, used to identify the session
+         */
         SessionId sId;
+
+        /**
+         * @property The packet payload size, used to know the size of the payload
+         */
         PayloadSize pSize;
     }
 #ifdef _WIN32

include/Polymorph/Network/tcp/Client.hpp

@@ -170,9 +170,6 @@ namespace polymorph::network::tcp
              */
             void _doReceive();
 
-            // TODO: remove ?
-            bool _broadcastReceivedPacket(const PacketHeader &header, const std::vector<std::byte> &bytes);
-
 
 //////////////////////--------------------------/////////////////////////
 

include/Polymorph/Network/udp/IClientConnection.hpp

@@ -20,14 +20,32 @@ namespace polymorph::network::tcp
         public:
             virtual ~IClientConnection() = default;
 
+            /**
+             * @brief Start accepting connection
+             */
             virtual void start() = 0;
 
+            /**
+             * @brief Send a packet to the client
+             * @tparam T The type of the payload
+             * @param payload The payload to send
+             * @param callback The callback to call when the packet is sent
+             */
             virtual void send(std::vector<std::byte> data, std::function<void (const PacketHeader &, const std::vector<std::byte> &)> callback) = 0;
 
+            /**
+             * @brief Check if the client is connected
+             */
             virtual bool isConnected() = 0;
 
+            /**
+             * @brief Get the current client session id
+             */
             virtual SessionId getSessionId() = 0;
 
+            /**
+             * @brief Get the current last packet id
+             */
             virtual PacketId getPacketId() = 0;
     };
 }

include/Polymorph/Network/udp/Server.hpp

@@ -46,10 +46,13 @@ namespace polymorph::network::udp
             ServerPacketManager _packetManager;
 
             /**
-             * @brief The session store used to manage the sessions
+             * @property The session store used to manage the sessions
              */
             SessionStore &_sessionStore;
 
+            /**
+             * @property The safeties map used to determine if a packet require ack or not
+             */
             std::map<OpId, bool> _safeties;
 
 
@@ -70,7 +73,7 @@ namespace polymorph::network::udp
          * @param from The recipient of the initial packet
          * @param acknowledgedId The acknowledged packet id
          */
-        void ackReceived(const asio::ip::udp::endpoint& from, PacketId acknowledgedId);
+        void ackReceived(const asio::ip::udp::endpoint& from, PacketId acknowledgedId) override;
 
         /**
          * @brief Method called when a packet is sent, it confirms the sent and enable the auto re-send feature for safe packets