ENet笔记

typedef struct _ENetCallbacks
{
    void * (ENET_CALLBACK * malloc) (size_t size);
    void (ENET_CALLBACK * free) (void * memory);
    void (ENET_CALLBACK * no_memory) (void);
} ENetCallbacks;

typedef struct _ENetPacket
{
    size_t referenceCount;/* 引用计数，分片的时候一个Packet会被多个Command引用 */
    enet_uint32 flags;/* 控制信息 */
    enet_uint8 * data;/* 上层传下来的数据 */
    size_t dataLength;/* 数据长度 */
    ENetPacketFreeCallback freeCallback;/* 当该Packet被销毁之前会调用，用于添加调试信息，默认为NULL，需在创建之后手动赋值，或修改创建逻辑 */
    void * userData;/* 自定义数据，协议中不会用到，可本地记录用于调试 */
} ENetPacket;

typedef enum _ENetPacketFlag
{
    ENET_PACKET_FLAG_RELIABLE = (1 << 0),/* 发送后必须收到对方的ACK之后才算成功，否则超时后会重发 */
    ENET_PACKET_FLAG_UNSEQUENCED = (1 << 1),/* 这个Packet不会改变协议中的序号，在无序的状态收发，可靠包时该位无效 */
    ENET_PACKET_FLAG_NO_ALLOCATE = (1 << 2),/* 创建包的时候不会为数据新分配内存，直接使用原来的内存，释放包时不会释放data */
    ENET_PACKET_FLAG_UNRELIABLE_FRAGMENT = (1 << 3),/* 当这个包需要分片时采用非可靠的方式 */
    ENET_PACKET_FLAG_SENT = (1 << 8)/* 引用这个包的所有Command是否都已发送 */
} ENetPacketFlag;

-------------------------------------------------
|   0 -  7  |   8 - 15  |  16 - 23  |  24 - 31  |
-------------------------------------------------
|  command  | channelID |   reliableSeqNumber   |
-------------------------------------------------

command /* 上述Enum中定义的值 */
channelID /* 发送的时候是对方的ID，接收的时候是自己的ID */
reliableSeqNumber /* 发送方的ReliableSeqNo */

typedef struct _ENetAcknowledgement
{
    ENetListNode acknowledgementList;/* 链表节点 */
    enet_uint32  sentTime;/* 对方的发送时间 */
    ENetProtocol command;/* 待回复的协议 */
    /* 没有Packet */
} ENetAcknowledgement;

typedef struct _ENetOutgoingCommand
{
    ENetListNode outgoingCommandList;/* 链表节点 */
    enet_uint16  reliableSequenceNumber;
    enet_uint16  unreliableSequenceNumber;/* 发送序号 */
    enet_uint32  sentTime;/* 发送时间，非可靠包无效 */
    enet_uint32  roundTripTimeout;/* 重发超时时间 */
    enet_uint32  roundTripTimeoutLimit;/* 断线超时时间 */
    enet_uint32  fragmentOffset;/* 片偏移量，Packet过大时用，否则为0 */
    enet_uint16  fragmentLength;/* 片长度，表示该Command下发送数据的实际长度 */
    enet_uint16  sendAttempts;/* 发送次数，每次重发该值+1 */
    ENetProtocol command;/* 待发送的协议 */
    ENetPacket * packet;/* 待发送的Packet，即使分片引用的也是整个包 */
} ENetOutgoingCommand;

typedef struct _ENetIncomingCommand
{
    ENetListNode     incomingCommandList;/* 链表节点 */
    enet_uint16      reliableSequenceNumber;
    enet_uint16      unreliableSequenceNumber;/* 接收序号 */
    ENetProtocol     command;/* 收到的协议 */
    enet_uint32      fragmentCount;/* 分片总数 */
    enet_uint32      fragmentsRemaining;/* 剩余片数 */
    enet_uint32 *    fragments;/* 数组用bit位记录哪些片已收到，当所有片的位都置1，表示这个包已收到 */
    ENetPacket *     packet;/* 收到的Packet，即使分片引用的也是整个包 */
} ENetIncomingCommand;

typedef struct _ENetChannel
{
    enet_uint16  outgoingReliableSequenceNumber;/* 发送可靠包(加入队列)前序号+1，send要指定channelID */
    enet_uint16  outgoingUnreliableSequenceNumber;/* 发送非可靠包(加入队列)前序号+1，如果发送了可靠包，该值重置，send要指定channelID */
    enet_uint16  usedReliableWindows;/* 一共16个可靠窗口，16位分别表示是否被使用 */
    enet_uint16  reliableWindows[ENET_PEER_RELIABLE_WINDOWS];/* 每个可靠窗口中ENetOutgoingCommand的数量，首次发包+1，收到ACK后-1 */
    enet_uint16  incomingReliableSequenceNumber;/* 收到可靠包被分到peer之前更新 */
    enet_uint16  incomingUnreliableSequenceNumber;/* 收到非可靠包被分到peer之前更新，如果分了可靠包到peer，该值重置 */
    ENetList     incomingReliableCommands;
    ENetList     incomingUnreliableCommands;/* 收到的包会首先挂在这个队列下面 */
} ENetChannel;

typedef struct _ENetPeer
{
    ENetListNode  dispatchList;/* 所有收到数据的ENetPeer会被挂在一个队列下统一分发 */
    struct _ENetHost * host;/* 所属的ENetHost */
    enet_uint16   outgoingPeerID;/* 建立连接后对方的PeerID */
    enet_uint16   incomingPeerID;/* 自己的PeerID，创建ENetHost时统一分配 */
    enet_uint32   connectID;/* 不同ENetHost的同序号ENetPeer用connectID区分，保证连接唯一；客户端允许同IP，但不允许同IP同端口同connectID */
    enet_uint8    outgoingSessionID;/* 握手的时候用，握手完之后和对方的incomingSessionID相等，发数据的时候带上 */
    enet_uint8    incomingSessionID;/* 握手的时候用，握手完之后和对方的outgoingSessionID相等，收数据的时候检查 */
    ENetAddress   address;/* 对方的地址和端口 */
    void *        data;/* 自由数据 */
    ENetPeerState state;/* ENetPeer状态 */
    ENetChannel * channels;/* 通道数组 */
    size_t        channelCount;/* 通道总数 */
    enet_uint32   incomingBandwidth;/* 对方的下行速率 bytes/second */
    enet_uint32   outgoingBandwidth;/* 对方的上行速率 bytes/second */
    enet_uint32   incomingBandwidthThrottleEpoch;
    enet_uint32   outgoingBandwidthThrottleEpoch;/* 上次发生限流计算的时间 */
    enet_uint32   incomingDataTotal;/* 收到的总字节数，收到的时机在sock_receive后dispatch前，限流计算后清零，peer重置时清零 */
    enet_uint32   outgoingDataTotal;/* 发送的总字节数，发送的时机在enet_send后queue前，限流计算后清零，peer重置时清零 */
    enet_uint32   lastSendTime;/* 最近一次发送时间，时机在sock_send前，peer重置时清零 */
    enet_uint32   lastReceiveTime;/* 最近一次收到ACK的时间，时机在sock_receive后，peer重置时清零 */
    enet_uint32   nextTimeout;/* 处在队列首部的Command的超时时间，peer重置时清零 */
    enet_uint32   earliestTimeout;/* 所有超时的Command中最早的发送时间，处理ACK时清零，peer重置时清零 */
    enet_uint32   packetLossEpoch;/* 最近一次计算丢包率的时间，时机在queue后sock_send前，peer重置时清零 */
    enet_uint32   packetsSent;/* 连Command带挂着的packet算一个，计算丢包率后清零，重发的再次计算 */
    enet_uint32   packetsLost;/* 连Command带挂着的packet算一个，计算丢包率后清零，重发的再次计算 */
    enet_uint32   packetLoss;/* 平均丢包率 */
    enet_uint32   packetLossVariance;/* 丢包率方差 */
    /* ENet主动丢非可靠包 */
    enet_uint32   packetThrottle;
    enet_uint32   packetThrottleLimit;
    enet_uint32   packetThrottleCounter;
    enet_uint32   packetThrottleEpoch;
    enet_uint32   packetThrottleAcceleration;
    enet_uint32   packetThrottleDeceleration;
    enet_uint32   packetThrottleInterval;
    /* ENet主动丢非可靠包 */
    /* ENet被动丢可靠包 */
    enet_uint32   pingInterval;
    enet_uint32   timeoutLimit;/* 32 */
    enet_uint32   timeoutMinimum;/* 5000 */
    enet_uint32   timeoutMaximum;/* 30000(5000 in PM02) */
    enet_uint32   lastRoundTripTime;
    enet_uint32   lowestRoundTripTime;
    enet_uint32   lastRoundTripTimeVariance;
    enet_uint32   highestRoundTripTimeVariance;
    enet_uint32   roundTripTime;/* 平均RTT */
    enet_uint32   roundTripTimeVariance;/* RTT方差 */
    /* ENet被动丢可靠包 */
    enet_uint32   mtu;
    enet_uint32   windowSize;
    enet_uint32   reliableDataInTransit;
    enet_uint16   outgoingReliableSequenceNumber;
    ENetList      acknowledgements;
    ENetList      sentReliableCommands;
    ENetList      sentUnreliableCommands;
    ENetList      outgoingReliableCommands;
    ENetList      outgoingUnreliableCommands;
    ENetList      dispatchedCommands;
    int           needsDispatch;
    enet_uint16   incomingUnsequencedGroup;
    enet_uint16   outgoingUnsequencedGroup;
    enet_uint32   unsequencedWindow[ENET_PEER_UNSEQUENCED_WINDOW_SIZE / 32];
    enet_uint32   eventData;
    size_t        totalWaitingData;/* dispatchedCommands下所有Packet的字节总数 */
} ENetPeer;

typedef struct _ENetHost
{
    ENetSocket           socket;
    ENetAddress          address;/* 本主机地址 */
    enet_uint32          incomingBandwidth;/* 下行速率 bytes/second */
    enet_uint32          outgoingBandwidth;/* 上行速率 bytes/second */
    enet_uint32          bandwidthThrottleEpoch;
    enet_uint32          mtu;/*最大传输单元，默认1400 */
    enet_uint32          randomSeed;/* 分配connectID用 */
    int                  recalculateBandwidthLimits;/* 在带宽限流时标记带宽是否要重新计算，有新连接或断开连接时 */
    ENetPeer *           peers;
    size_t               peerCount;
    size_t               channelLimit;/* 每个Peer允许的最大channel数 */
    enet_uint32          serviceTime;/* 当前时间，host以下的对象获取时间从这里读，host本身从系统读，单位毫秒 */
    ENetList             dispatchQueue;/* 有数据的Peer挂在这个队列下，数据由Host传给应用 */
    int                  continueSending;/* 一个窗口满了但是还有包没发出去时置1，表示还要继续发送 */
    size_t               packetSize;/* 某次发送中一共缓存的字节数，用于和mtu比较判断是否可以再加新包进来 */
    enet_uint16          headerFlags;/* 某次发送的头部标记，包括是否要带发送时间，是否压缩等，发送时存放在peerId的高16位中 */
    /* UDP发送Buffer */
    ENetProtocol         commands[ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS];
    size_t               commandCount;
    ENetBuffer           buffers[ENET_BUFFER_MAXIMUM];
    size_t               bufferCount;
    /* UDP发送Buffer */
    ENetChecksumCallback checksum;/* 校验和 */
    ENetCompressor       compressor;/* 压缩 */
    enet_uint8           packetData[2][ENET_PROTOCOL_MAXIMUM_MTU];/* 0用来缓存sock_recv的数据报，1用来缓存压缩解压缩的结果 */
    ENetAddress          receivedAddress;/* 传给指定Peer的对方地址，如果未建立连接则用于通知，如果已建立则用于校验 */
    enet_uint8 *         receivedData;/* 未压缩则软链到packetData[0]，压缩则软链到packetData[1] */
    size_t               receivedDataLength;/* 收到数据长度 */
    enet_uint32          totalSentData;/* 发送的字节数，不会定期清零，要手动处理 */
    enet_uint32          totalSentPackets;/* 发送的包数，Host级别的包指一次发送的Peer级别包的集合，不会定期清零，要手动处理 */
    enet_uint32          totalReceivedData;/* 收到的字节数，不会定期清零，要手动处理 */
    enet_uint32          totalReceivedPackets;/* 收到的包数，Host级别的包，不会定期清零，要手动处理 */
    ENetInterceptCallback intercept;/* 默认解包方法，如果忽略则按ENet自带的方法解包 */
    size_t               connectedPeers;/* 活跃连接数 */
    size_t               bandwidthLimitedPeers;/* 限制了带宽的连接数 */
    size_t               duplicatePeers;/* 允许同IP的peer数 */
    size_t               maximumPacketSize;/* 应用层单次发送数据限制32MB */
    size_t               maximumWaitingData;/* Host缓存的应用层数据最大限制32MB */
    char                 kcpBuffer[ENET_KCP_BUFF_SIZE];
    ENetList             kcpDispatchQueue;
} ENetHost;

-----------------------------------------
|  0 -  7 |  8 - 15 | 16 - 23 | 24 - 31 |
-----------------------------------------
|        host       |        port       |
-----------------------------------------

---------------------------------------------------------------------------------
|       0 -  7      |       8 - 15      |      16 - 23      |      24 - 31      |
---------------------------------------------------------------------------------
|      command      |     channelID     |         reliableSequenceNumber        |
---------------------------------------------------------------------------------
|            outgoingPeerID             | incomingSessionID | outgoingSessionID |
---------------------------------------------------------------------------------
|                                      mtu                                      |
---------------------------------------------------------------------------------
|                                  windowSize                                   |
---------------------------------------------------------------------------------
|                                 channelCount                                  |
---------------------------------------------------------------------------------
|                               incomingBandwidth                               |
---------------------------------------------------------------------------------
|                               outgoingBandwidth                               |
---------------------------------------------------------------------------------
|                            packetThrottleInterval                             |
---------------------------------------------------------------------------------
|                           packetThrottleAcceleration                          |
---------------------------------------------------------------------------------
|                           packetThrottleDeceleration                          |
---------------------------------------------------------------------------------
|                                   connectID                                   |
---------------------------------------------------------------------------------
|                                     data                                      |
---------------------------------------------------------------------------------

---------------------------------------------------------------------------------
|       0 -  7      |       8 - 15      |      16 - 23      |      24 - 31      |
---------------------------------------------------------------------------------
|      command      |     channelID     |         reliableSequenceNumber        |
---------------------------------------------------------------------------------
|            outgoingPeerID             | incomingSessionID | outgoingSessionID |
---------------------------------------------------------------------------------
|                                      mtu                                      |
---------------------------------------------------------------------------------
|                                  windowSize                                   |
---------------------------------------------------------------------------------
|                                 channelCount                                  |
---------------------------------------------------------------------------------
|                               incomingBandwidth                               |
---------------------------------------------------------------------------------
|                               outgoingBandwidth                               |
---------------------------------------------------------------------------------
|                            packetThrottleInterval                             |
---------------------------------------------------------------------------------
|                           packetThrottleAcceleration                          |
---------------------------------------------------------------------------------
|                           packetThrottleDeceleration                          |
---------------------------------------------------------------------------------
|                                   connectID                                   |
---------------------------------------------------------------------------------

---------------------------------------------------------------------------------
|       0 -  7      |       8 - 15      |      16 - 23      |      24 - 31      |
---------------------------------------------------------------------------------
|      command      |     channelID     |         reliableSequenceNumber        |
---------------------------------------------------------------------------------
|     receivedReliableSequenceNumber    |            receivedSentTime           |
---------------------------------------------------------------------------------