diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/addons.markdown | 2 | ||||
| -rw-r--r-- | doc/api/appendix_1.markdown | 2 | ||||
| -rw-r--r-- | doc/api/https.markdown | 12 | ||||
| -rw-r--r-- | doc/api/modules.markdown | 4 | ||||
| -rw-r--r-- | doc/api/net.markdown | 27 | ||||
| -rw-r--r-- | doc/index.html | 8 |
6 files changed, 48 insertions, 7 deletions
diff --git a/doc/api/addons.markdown b/doc/api/addons.markdown index 847d4144b..5d8edd02d 100644 --- a/doc/api/addons.markdown +++ b/doc/api/addons.markdown @@ -77,4 +77,4 @@ All Node addons must export a function called `init` with this signature: extern 'C' void init (Handle<Object> target) For the moment, that is all the documentation on addons. Please see -<http://github.com/joyent/node_postgres> for a real example. +<https://github.com/ry/node_postgres> for a real example. diff --git a/doc/api/appendix_1.markdown b/doc/api/appendix_1.markdown index ea2700dea..c035466fd 100644 --- a/doc/api/appendix_1.markdown +++ b/doc/api/appendix_1.markdown @@ -21,7 +21,7 @@ elsewhere. - [mDNS/Zeroconf/Bonjour](http://github.com/agnat/node_mdns) -- [RabbitMQ, AMQP](http://github.com/joyent/node-amqp) +- [RabbitMQ, AMQP](https://github.com/ry/node-amqp) - [mysql](http://github.com/felixge/node-mysql) diff --git a/doc/api/https.markdown b/doc/api/https.markdown index b98c16b1f..3c6a7c43a 100644 --- a/doc/api/https.markdown +++ b/doc/api/https.markdown @@ -53,6 +53,18 @@ Example: console.error(e); }); +The options argument has the following options + +- host: IP or domain of host to make request to. Defaults to `'localhost'`. +- port: port of host to request to. Defaults to 443. +- path: Path to request. Default `'/'`. +- method: HTTP request method. Default `'GET'`. +- key: Private key to use for SSL. Default `null`. +- cert: Public x509 certificate to use. Default `null`. +- ca: An authority certificate or array of authority certificates to check + the remote host against. + + ## https.get(options, callback) Like `http.get()` but for HTTPS. diff --git a/doc/api/modules.markdown b/doc/api/modules.markdown index 5f2b747ee..f07fcd252 100644 --- a/doc/api/modules.markdown +++ b/doc/api/modules.markdown @@ -212,6 +212,10 @@ the `NODE_PATH` environment variable might have been set to: /home/micheil/.node_modules:/usr/local/lib/node_modules +Loading from the `require.paths` locations is only performed if the +module could not be found using the `node_modules` algorithm above. +Global modules are lower priority than bundled dependencies. + #### **Note:** Please Avoid Modifying `require.paths` For compatibility reasons, `require.paths` is still given first priority diff --git a/doc/api/net.markdown b/doc/api/net.markdown index 6c67666b0..e3321e02d 100644 --- a/doc/api/net.markdown +++ b/doc/api/net.markdown @@ -4,11 +4,21 @@ The `net` module provides you with an asynchronous network wrapper. It contains methods for creating both servers and clients (called streams). You can include this module with `require("net");` -### net.createServer(connectionListener) +### net.createServer([options], [connectionListener]) Creates a new TCP server. The `connectionListener` argument is automatically set as a listener for the `'connection'` event. +`options` is an object with the following defaults: + + { 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 @@ -153,6 +163,21 @@ and passed to the user through the `'connection'` event of a server. `net.Socket` instances are EventEmitters with the following events: +#### new net.Socket([options]) + +Construct a new socket object. + +`options` is an object with the following defaults: + + { fd: null + type: null + allowHalfOpen: false + } + +`fd` allows you to specify the existing file descriptor of socket. `type` +specified underlying protocol. It can be `'tcp4'`, `'tcp6'`, or `'unix'`. +About `allowHalfOpen`, refer to `createServer()` and `'end'` event. + #### socket.connect(port, [host], [callback]) #### socket.connect(path, [callback]) diff --git a/doc/index.html b/doc/index.html index 34dc236eb..a6b5d8483 100644 --- a/doc/index.html +++ b/doc/index.html @@ -20,7 +20,7 @@ <li><a href="#download">Download</a></li> <li><a href="https://github.com/joyent/node/raw/master/ChangeLog">ChangeLog</a></li> <li><a href="#about">About</a></li> - <li><a href="http://nodejs.org/docs/v0.4.1/api">v0.4.1 docs</a></li> + <li><a href="http://nodejs.org/docs/v0.4.2/api">v0.4.2 docs</a></li> <br/> <li><B><a href="https://github.com/joyent/node/wiki">Wiki</a></B></li> </ol> @@ -91,9 +91,9 @@ server.listen(8124, "127.0.0.1"); </p> <p> - 2011.02.19 - <a href="http://nodejs.org/dist/node-v0.4.1.tar.gz">node-v0.4.1.tar.gz</a> - (<a href="http://nodejs.org/docs/v0.4.1/api/index.html">Documentation</a>) + 2011.03.02 + <a href="http://nodejs.org/dist/node-v0.4.2.tar.gz">node-v0.4.2.tar.gz</a> + (<a href="http://nodejs.org/docs/v0.4.2/api/index.html">Documentation</a>) </p> <p>Historical: <a href="http://nodejs.org/dist">versions</a>, <a href="http://nodejs.org/docs">docs</a></p> |