enet_peer_send note about failure and enet_packet_destroy

lsalzman · Feb 20, 2022 · bd0115c · bd0115c
1 parent 987cd06
commit bd0115c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/peer.c b/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