Document allowHalfOpen for net.createServer()
authorkoichik <koichik@improvement.jp>
Thu, 3 Mar 2011 16:05:03 +0000 (01:05 +0900)
committerRyan Dahl <ry@tinyclouds.org>
Mon, 7 Mar 2011 18:17:22 +0000 (10:17 -0800)
doc/api/net.markdown

index a4af6db..25b9f92 100644 (file)
@@ -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