Document allowHalfOpen for net.createServer()

kenosaur · Mar 7, 2011 · 07426ef · 07426ef
1 parent 5e91042
commit 07426ef
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/api/net.markdown b/doc/api/net.markdown
@@ -14,6 +14,11 @@ automatically set as a listener for the `'connection'` event.
     { allowHalfOpen: false
     }
 
+If `allowHalfOpen` is `true`, then the socket won't automatically send FIN
+packet when the other end of the socket sends a FIN packet. The socket becomes
+non-readable, but still writable. You should call the end() method explicitly.
+See `'end'` event for more information.
+
 ### net.createConnection(arguments...)
 
 Construct a new socket object and opens a socket to the given location. When