Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save koichik/853011 to your computer and use it in GitHub Desktop.
Save koichik/853011 to your computer and use it in GitHub Desktop.
Document allowHalfOpen for net.createServer()
From 19e8812e34cdc9733cb82d4261ed34aab83659e9 Mon Sep 17 00:00:00 2001
From: koichik <koichik@improvement.jp>
Date: Fri, 4 Mar 2011 01:05:03 +0900
Subject: [PATCH 1/2] Document allowHalfOpen for net.createServer()
---
doc/api/net.markdown | 5 +++++
1 files changed, 5 insertions(+), 0 deletions(-)
diff --git a/doc/api/net.markdown b/doc/api/net.markdown
index a4af6db..25b9f92 100644
--- 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
--
1.7.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment