Browse Source

enet_peer_send note about failure and enet_packet_destroy

Lee Salzman 3 years ago
parent
commit
bd0115c907
1 changed files with 5 additions and 0 deletions
  1. 5 0
      peer.c

+ 5 - 0
peer.c

@@ -90,6 +90,11 @@ enet_peer_throttle (ENetPeer * peer, enet_uint32 rtt)
 }
 
 /** Queues a packet to be sent.
+
+    On success, ENet will assume ownership of the packet, and so enet_packet_destroy
+    should not be called on it thereafter. On failure, the caller still must destroy
+    the packet on its own as ENet has not queued the packet.
+
     @param peer destination for the packet
     @param channelID channel on which to send
     @param packet packet to send