Document that network_write manipulates non-blocking status

Change-Id: I7131daf0387b2fabb05fdb237ac7fae7cdaac5b6

1 files changed, 4 insertions, 0 deletions

diff --git a/util/network.h b/util/network.h
index 0aeea53..f04a65c 100644
--- a/util/network.h
+++ b/util/network.h
@@ -111,6 +111,10 @@ socket_type network_client_create(int domain, int type, const char *source);
  * Read or write the specified number of bytes to the network, enforcing a
  * timeout.  Both return true on success and false on failure; on failure, the
  * socket errno is set.
+ *
+ * network_write will set the file descriptor non-blocking and then set it
+ * back to blocking at the conclusion of the write, so don't use this function
+ * with file descriptors that should stay non-blocking.
  */
 bool network_read(socket_type, void *, size_t, time_t)
     __attribute__((__nonnull__));