38..Node.js工具模块---底层的网络通讯--Net模块

转自：http://www.runoob.com/nodejs/nodejs-module-system.html

Node.js Net 模块提供了一些用于底层的网络通讯的小工具，包含了建立服务器/客户端的方法，咱们能够经过如下方式引入该模块：

var net = require("net")

方法

序号	方法 & 描述
1	net.createServer([options][, connectionListener]) 建立一个 TCP 服务器。参数 connectionListener 自动给 'connection' 事件建立监听器。
2	net.connect(options[, connectionListener]) 返回一个新的 'net.Socket'，并链接到指定的地址和端口。 当 socket 创建的时候，将会触发 'connect' 事件。
3	net.createConnection(options[, connectionListener]) 建立一个到端口 port 和 主机 host的 TCP 链接。 host 默认为 'localhost'。
4	net.connect(port[, host][, connectListener]) 建立一个端口为 port 和主机为 host的 TCP 链接 。host 默认为 'localhost'。参数 connectListener 将会做为监听器添加到 'connect' 事件。返回 'net.Socket'。
5	net.createConnection(port[, host][, connectListener]) 建立一个端口为 port 和主机为 host的 TCP 链接 。host 默认为 'localhost'。参数 connectListener 将会做为监听器添加到 'connect' 事件。返回 'net.Socket'。
6	net.connect(path[, connectListener]) 建立链接到 path 的 unix socket 。参数 connectListener 将会做为监听器添加到 'connect' 事件上。返回 'net.Socket'。
7	net.createConnection(path[, connectListener]) 建立链接到 path 的 unix socket 。参数 connectListener 将会做为监听器添加到 'connect' 事件。返回 'net.Socket'。
8	net.isIP(input) 检测输入的是否为 IP 地址。 IPV4 返回 4， IPV6 返回 6，其余状况返回 0。
9	net.isIPv4(input) 若是输入的地址为 IPV4， 返回 true，不然返回 false。
10	net.isIPv6(input) 若是输入的地址为 IPV6， 返回 true，不然返回 false。

---

net.Server

net.Server一般用于建立一个 TCP 或本地服务器。

序号	方法 & 描述
1	server.listen(port[, host][, backlog][, callback]) 监听指定端口 port 和 主机 host ac链接。 默认状况下 host 接受任何 IPv4 地址(INADDR_ANY)的直接链接。端口 port 为 0 时，则会分配一个随机端口。
2	server.listen(path[, callback]) 经过指定 path 的链接，启动一个本地 socket 服务器。
3	server.listen(handle[, callback]) 经过指定句柄链接。
4	server.listen(options[, callback]) options 的属性：端口 port, 主机 host, 和 backlog, 以及可选参数 callback 函数, 他们在一块儿调用server.listen(port, [host], [backlog], [callback])。还有，参数 path 能够用来指定 UNIX socket。
5	server.close([callback]) 服务器中止接收新的链接，保持现有链接。这是异步函数，当全部链接结束的时候服务器会关闭，并会触发 'close' 事件。
6	server.address() 操做系统返回绑定的地址，协议族名和服务器端口。
7	server.unref() 若是这是事件系统中惟一一个活动的服务器，调用 unref 将容许程序退出。
8	server.ref() 与 unref 相反，若是这是惟一的服务器，在以前被 unref 了的服务器上调用 ref 将不会让程序退出（默认行为）。若是服务器已经被 ref，则再次调用 ref 并不会产生影响。
9	server.getConnections(callback) 异步获取服务器当前活跃链接的数量。当 socket 发送给子进程后才有效；回调函数有 2 个参数 err 和 count。

事件

序号	事件 & 描述
1	listening 当服务器调用 server.listen 绑定后会触发。
2	connection 当新链接建立后会被触发。socket 是 net.Socket实例。
3	close 服务器关闭时会触发。注意，若是存在链接，这个事件不会被触发直到全部的链接关闭。
4	error 发生错误时触发。'close' 事件将被下列事件直接调用。

---

net.Socket

net.Socket 对象是 TCP 或 UNIX Socket 的抽象。net.Socket 实例实现了一个双工流接口。 他们能够在用户建立客户端(使用 connect())时使用, 或者由 Node 建立它们，并经过 connection 服务器事件传递给用户。

事件

net.Socket 事件有：

序号	事件 & 描述
1	lookup 在解析域名后，但在链接前，触发这个事件。对 UNIX sokcet 不适用。
2	connect 成功创建 socket 链接时触发。
3	data 当接收到数据时触发。
4	end 当 socket 另外一端发送 FIN 包时，触发该事件。
5	timeout 当 socket 空闲超时时触发，仅是代表 socket 已经空闲。用户必须手动关闭链接。
6	drain 当写缓存为空得时候触发。可用来控制上传。
7	error 错误发生时触发。
8	close 当 socket 彻底关闭时触发。参数 had_error 是布尔值，它表示是否由于传输错误致使 socket 关闭。

属性

net.Socket 提供了不少有用的属性，便于控制 socket 交互：

序号	属性 & 描述
1	socket.bufferSize 该属性显示了要写入缓冲区的字节数。
2	socket.remoteAddress 远程的 IP 地址字符串，例如：'74.125.127.100' or '2001:4860:a005::68'。
3	socket.remoteFamily 远程IP协议族字符串，好比 'IPv4' or 'IPv6'。
4	socket.remotePort 远程端口，数字表示，例如：80 or 21。
5	socket.localAddress 网络链接绑定的本地接口 远程客户端正在链接的本地 IP 地址，字符串表示。例如，若是你在监听'0.0.0.0'而客户端链接在'192.168.1.1'，这个值就会是 '192.168.1.1'。
6	socket.localPort 本地端口地址，数字表示。例如：80 or 21。
7	socket.bytesRead 接收到得字节数。
8	socket.bytesWritten 发送的字节数。

方法

序号	方法 & 描述
1	new net.Socket([options]) 构造一个新的 socket 对象。
2	socket.connect(port[, host][, connectListener]) 指定端口 port 和 主机 host，建立 socket 链接 。参数 host 默认为 localhost。一般状况不须要使用 net.createConnection 打开 socket。只有你实现了本身的 socket 时才会用到。
3	socket.connect(path[, connectListener]) 打开指定路径的 unix socket。一般状况不须要使用 net.createConnection 打开 socket。只有你实现了本身的 socket 时才会用到。
4	socket.setEncoding([encoding]) 设置编码
5	socket.write(data[, encoding][, callback]) 在 socket 上发送数据。第二个参数指定了字符串的编码，默认是 UTF8 编码。
6	socket.end([data][, encoding]) 半关闭 socket。例如，它发送一个 FIN 包。可能服务器仍在发送数据。
7	socket.destroy() 确保没有 I/O 活动在这个套接字上。只有在错误发生状况下才须要。（处理错误等等）。
8	socket.pause() 暂停读取数据。就是说，不会再触发 data 事件。对于控制上传很是有用。
9	socket.resume() 调用 pause() 后想恢复读取数据。
10	socket.setTimeout(timeout[, callback]) socket 闲置时间超过 timeout 毫秒后 ，将 socket 设置为超时。
11	socket.setNoDelay([noDelay]) 禁用纳格（Nagle）算法。默认状况下 TCP 链接使用纳格算法，在发送前他们会缓冲数据。将 noDelay 设置为 true 将会在调用 socket.write() 时当即发送数据。noDelay 默认值为 true。
12	socket.setKeepAlive([enable][, initialDelay]) 禁用/启用长链接功能，并在发送第一个在闲置 socket 上的长链接 probe 以前，可选地设定初始延时。默认为 false。 设定 initialDelay （毫秒），来设定收到的最后一个数据包和第一个长链接probe之间的延时。将 initialDelay 设为0，将会保留默认（或者以前）的值。默认值为0.
13	socket.address() 操做系统返回绑定的地址，协议族名和服务器端口。返回的对象有 3 个属性，好比{ port: 12346, family: 'IPv4', address: '127.0.0.1' }。
14	socket.unref() 若是这是事件系统中惟一一个活动的服务器，调用 unref 将容许程序退出。若是服务器已被 unref，则再次调用 unref 并不会产生影响。
15	socket.ref() 与 unref 相反，若是这是惟一的服务器，在以前被 unref 了的服务器上调用 ref 将不会让程序退出（默认行为）。若是服务器已经被 ref，则再次调用 ref 并不会产生影响。

实例

建立 server.js 文件，代码以下所示：

var net = require('net'); var server = net.createServer(function(connection) { console.log('client connected'); connection.on('end', function() { console.log('客户端关闭链接'); }); connection.write('Hello World!\r\n'); connection.pipe(connection); }); server.listen(8080, function() { console.log('server is listening'); });

执行以上服务端代码：

$ node server.js server is listening # 服务已建立并监听 8080 端口

新开一个窗口，建立 client.js 文件，代码以下所示：

var net = require('net'); var client = net.connect({port: 8080}, function() { console.log('链接到服务器！'); }); client.on('data', function(data) { console.log(data.toString()); client.end(); }); client.on('end', function() { console.log('断开与服务器的链接'); });

执行以上客户端的代码：

链接到服务器！ Hello World! 断开与服务器的链接