icmpd cleanup

1 files changed, 10 insertions, 0 deletions

diff --git a/icmpd.h b/icmpd.h
index 2c46788..e5daf7b 100644
--- a/icmpd.h
+++ b/icmpd.h
@@ -13,6 +13,16 @@ struct icmpd_received {
 };
 
 
+// The interface exposed here is NOT thread-safe. Having multiple threads in
+// in the same process working with icmpd is unsafe, since internal communication
+// assumes one calling thread.
+
+
+// This functions as a "connection" with another party. A server should create
+// a new connection for each client it communicates with (in addition to a
+// single possible client_addr=0 connection for receiving connection requests),
+// and likewise a client should create a new connection for each server it
+// communicates with.
 struct icmpd;
 
 // Pass 0 as client_addr to listen for messages from any IP (this channel