More work on TCP, approaching usable (untested)

[tpg/acess2.git] / Modules / IPStack / tcp.h

diff --git a/Modules/IPStack/tcp.h b/Modules/IPStack/tcp.h
index cd6caf0..87515ce 100644 (file)
--- a/Modules/IPStack/tcp.h
+++ b/Modules/IPStack/tcp.h
@@ -9,6 +9,7 @@
 
 typedef struct sTCPHeader      tTCPHeader;
 typedef struct sTCPListener    tTCPListener;
+typedef struct sTCPStoredPacket        tTCPStoredPacket;
 typedef struct sTCPConnection  tTCPConnection;
 
 struct sTCPHeader
@@ -61,43 +62,48 @@ enum eTCPFlags
 
 struct sTCPListener
 {
-       struct sTCPListener     *Next;
-       Uint16  Port;
-       tInterface      *Interface;
-       tVFS_Node       Node;
-        int    NextID;
-       tTCPConnection  *Connections;
+       struct sTCPListener     *Next;  //!< Next server in the list
+       Uint16  Port;           //!< Listening port (0 disables the server)
+       tInterface      *Interface;     //!< Listening Interface
+       tVFS_Node       Node;   //!< Server Directory node
+        int    NextID;         //!< Name of the next connection
+       tSpinlock       lConnections;   //!< Spinlock for connections
+       tTCPConnection  *Connections;   //!< Connections (linked list)
+        tTCPConnection *volatile NewConnections;
+};
+
+struct sTCPStoredPacket
+{
+       struct sTCPStoredPacket *Next;
+       Uint32  Sequence;
+       Uint8   Data[];
 };
 
 struct sTCPConnection
 {
        struct sTCPConnection   *Next;
-        int    State;
-       Uint16  LocalPort;
-       Uint16  RemotePort;
-       tVFS_Node       Node;
+        int    State;  //!< Connection state (see ::eTCPConnectionState)
+       Uint16  LocalPort;      //!< Local port
+       Uint16  RemotePort;     //!< Remote port
+       tInterface      *Interface;     //!< Listening Interface
+       tVFS_Node       Node;   //!< Node
        
-        int    NextSequenceSend;
-        int    NextSequenceRcv;
+        int    NextSequenceSend;       //!< Next sequence value for outbound packets
+        int    NextSequenceRcv;        //!< Next expected sequence value for inbound
        
-        int    nQueuedPackets;
-       struct {
-                int    Sequence;
-               void    *Data;
-       }       *QueuedPackets;
+       tTCPStoredPacket        *QueuedPackets; //!< Non-ACKed packets
        
+       tSpinlock       lRecievedPackets;
+       tTCPStoredPacket        *RecievedPackets;       //!< Unread Packets
+       tTCPStoredPacket        *RecievedPacketsTail;   //!< Unread Packets (End of list)
        
-        int    nFuturePackets;
-       struct {
-                int    SequenceNum;
-               void    *Data;
-       }       **FuturePackets;
+       tTCPStoredPacket        *FuturePackets; //!< Out of sequence packets
        
-       tInterface      *Interface;
        union {
                tIPv4   v4;
                tIPv6   v6;
-       } RemoteIP;     // Type is determined by LocalInterface->Type
+       } RemoteIP;     //!< Remote IP Address
+       // Type is determined by LocalInterface->Type
 };
 
 enum eTCPConnectionState