Browse Source

doc: clarify factory methods for net.Socket

v0.10.31-release
Kevin Simper 11 years ago
committed by Timothy J Fontaine
parent
commit
70cc9968f6
  1. 10
      doc/api/net.markdown

10
doc/api/net.markdown

@ -53,9 +53,13 @@ Use `nc` to connect to a UNIX domain socket server:
## net.connect(options, [connectionListener])
## net.createConnection(options, [connectionListener])
Constructs a new socket object and opens the socket to the given location.
A factory method, which returns a new ['net.Socket'](#net_class_net_socket)
and connects to the supplied address and port.
When the socket is established, the ['connect'][] event will be emitted.
Has the same events as ['net.Socket'](#net_class_net_socket).
For TCP sockets, `options` argument should be an object which specifies:
- `port`: Port the client should connect to (Required).
@ -106,6 +110,8 @@ Creates a TCP connection to `port` on `host`. If `host` is omitted,
The `connectListener` parameter will be added as an listener for the
['connect'][] event.
Is a factory method which returns a new ['net.Socket'](#net_class_net_socket).
## net.connect(path, [connectListener])
## net.createConnection(path, [connectListener])
@ -113,6 +119,8 @@ Creates unix socket connection to `path`.
The `connectListener` parameter will be added as an listener for the
['connect'][] event.
A factory method which returns a new ['net.Socket'](#net_class_net_socket).
## Class: net.Server
This class is used to create a TCP or UNIX server.

Loading…
Cancel
Save