From 16d93ee168ef645b20208db7a3db13ff295d501a Mon Sep 17 00:00:00 2001
From: Stephen Birarda <commit@birarda.com>
Date: Fri, 17 Nov 2017 11:17:11 -0800
Subject: [PATCH] clarify signatures in LNL to send packet lists

---
 libraries/networking/src/LimitedNodeList.cpp |  6 +++---
 libraries/networking/src/LimitedNodeList.h   | 12 ++++++++++--
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/libraries/networking/src/LimitedNodeList.cpp b/libraries/networking/src/LimitedNodeList.cpp
index a9ebc5481d..1e682f367a 100644
--- a/libraries/networking/src/LimitedNodeList.cpp
+++ b/libraries/networking/src/LimitedNodeList.cpp
@@ -429,7 +429,7 @@ qint64 LimitedNodeList::sendPacket(std::unique_ptr<NLPacket> packet, const HifiS
     }
 }
 
-qint64 LimitedNodeList::sendPacketList(NLPacketList& packetList, const Node& destinationNode) {
+qint64 LimitedNodeList::sendUnreliableUnorderedPacketList(NLPacketList& packetList, const Node& destinationNode) {
     auto activeSocket = destinationNode.getActiveSocket();
 
     if (activeSocket) {
@@ -452,8 +452,8 @@ qint64 LimitedNodeList::sendPacketList(NLPacketList& packetList, const Node& des
     }
 }
 
-qint64 LimitedNodeList::sendPacketList(NLPacketList& packetList, const HifiSockAddr& sockAddr,
-                                       const QUuid& connectionSecret) {
+qint64 LimitedNodeList::sendUnreliableUnorderedPacketList(NLPacketList& packetList, const HifiSockAddr& sockAddr,
+                                                          const QUuid& connectionSecret) {
     qint64 bytesSent = 0;
 
     // close the last packet in the list
diff --git a/libraries/networking/src/LimitedNodeList.h b/libraries/networking/src/LimitedNodeList.h
index 868e36f160..e21f01a470 100644
--- a/libraries/networking/src/LimitedNodeList.h
+++ b/libraries/networking/src/LimitedNodeList.h
@@ -124,17 +124,25 @@ public:
 
     PacketReceiver& getPacketReceiver() { return *_packetReceiver; }
 
+    // use sendUnreliablePacket to send an unrelaible packet (that you do not need to move)
+    // either to a node (via its active socket) or to a manual sockaddr
     qint64 sendUnreliablePacket(const NLPacket& packet, const Node& destinationNode);
     qint64 sendUnreliablePacket(const NLPacket& packet, const HifiSockAddr& sockAddr,
                                 const QUuid& connectionSecret = QUuid());
 
+    // use sendPacket to send a moved unreliable or reliable NL packet to a node's active socket or manual sockaddr
     qint64 sendPacket(std::unique_ptr<NLPacket> packet, const Node& destinationNode);
     qint64 sendPacket(std::unique_ptr<NLPacket> packet, const HifiSockAddr& sockAddr,
                       const QUuid& connectionSecret = QUuid());
 
-    qint64 sendPacketList(NLPacketList& packetList, const Node& destinationNode);
-    qint64 sendPacketList(NLPacketList& packetList, const HifiSockAddr& sockAddr,
+    // use sendUnreliableUnorderedPacketList to unreliably send separate packets from the packet list
+    // either to a node's active socket or to a manual sockaddr
+    qint64 sendUnreliableUnorderedPacketList(NLPacketList& packetList, const Node& destinationNode);
+    qint64 sendUnreliableUnorderedPacketList(NLPacketList& packetList, const HifiSockAddr& sockAddr,
                           const QUuid& connectionSecret = QUuid());
+
+    // use sendPacketList to send reliable packet lists (ordered or unordered) to a node's active socket
+    // or to a manual sock addr
     qint64 sendPacketList(std::unique_ptr<NLPacketList> packetList, const HifiSockAddr& sockAddr);
     qint64 sendPacketList(std::unique_ptr<NLPacketList> packetList, const Node& destinationNode);