Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Commit

Permalink
Clarify some of the TCP API documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ry committed Aug 14, 2009
1 parent 0f888ed commit 95f9209
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions website/api.txt
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ added to the +"request"+ event.
+server.listen(port, hostname)+ :: +server.listen(port, hostname)+ ::
Begin accepting connections on the specified port and hostname. Begin accepting connections on the specified port and hostname.
If the hostname is omitted, the server will accept connections If the hostname is omitted, the server will accept connections
directed to any address. directed to any address. This function is synchronous.


+server.close()+ :: +server.close()+ ::
Stops the server from accepting new connections. Stops the server from accepting new connections.
Expand Down Expand Up @@ -957,20 +957,21 @@ the +"connection"+ event.


+server.listen(port, host=null, backlog=1024)+ :: +server.listen(port, host=null, backlog=1024)+ ::
Tells the server to listen for TCP connections to +port+ and +host+. Tells the server to listen for TCP connections to +port+ and +host+.

+
+host+ is optional. If +host+ is not specified the server will accept client +host+ is optional. If +host+ is not specified the server will accept client
connections on any network address. connections on any network address.

+
The third argument, +backlog+, is also optional and defaults to 1024. The The third argument, +backlog+, is also optional and defaults to 1024. The
+backlog+ argument defines the maximum length to which the queue of pending +backlog+ argument defines the maximum length to which the queue of pending
connections for the server may grow. If a connection request arrives when connections for the server may grow.
the queue is full, the client may receive a "ECONNREFUSED" error or, if the +
underlying protocol supports retransmission, the request may be ignored so This function is synchronous.
that a later reattempt at connection succeeds




+server.close()+:: +server.close()+::
Stops the server from accepting new connections. Stops the server from accepting new connections. This function is
asynchronous, the server is finally closed when the server emits a +"close"+
event.




==== +node.tcp.Connection+ ==== +node.tcp.Connection+
Expand All @@ -981,7 +982,9 @@ socket for +node.tcp.Server+.
[cols="1,2,10",options="header"] [cols="1,2,10",options="header"]
|========================================================= |=========================================================
|Event | Parameters | Notes |Event | Parameters | Notes
|+"connect"+ | | Call once the connection is established. |+"connect"+ | | Call once the connection is established
after a call to +createConnection()+ or
+connect()+.
|+"receive"+ | +data+ | Called when data is received on the |+"receive"+ | +data+ | Called when data is received on the
connection. Encoding of data is set connection. Encoding of data is set
by +connection.setEncoding()+. +data+ by +connection.setEncoding()+. +data+
Expand All @@ -1002,11 +1005,21 @@ socket for +node.tcp.Server+.
|========================================================= |=========================================================


+node.tcp.createConnection(port, host="127.0.0.1")+:: +node.tcp.createConnection(port, host="127.0.0.1")+::
Creates a new connection object and Creates a new connection object and opens a connection to the specified
opens a connection to the specified +port+ and +port+ and +host+. If the second parameter is omitted, localhost is assumed.
+host+. If the second parameter is omitted, localhost is +
assumed. When the connection is established the +"connect"+ event will be emitted.


+connection.connect(port, host="127.0.0.1")+::
Opens a connection to the specified +port+ and +host+. +createConnection()+
also opens a connection; normally this method is not needed. Use this only
if a connection is closed and you want to reuse the object to connect to
another server.
+
This function is asynchronous. When the +"connect"+ event is emitted the
connection is established. If there is a problem connecting, the +"connect"+
event will not be emitted, the +"disconnect"+ event will be emitted with
+had_error == true+.


+connection.remoteAddress+:: +connection.remoteAddress+::
The string representation of the remote IP address. For example, The string representation of the remote IP address. For example,
Expand Down

0 comments on commit 95f9209

Please sign in to comment.