TCP服務在網路應用中十分常見,目前大多數的應用都是以TCP建構而成的。 net模組提供了一個非同步網路包裝器,用於TCP網路編程,它包含了創建伺服器和客戶端的方法。本文將詳細介紹nodeJS中的net模組。
相關推薦:《nodejs 教學》
【net.isIP(input)】
測試是否輸入的為IP 位址。字串無效時傳回 0。 IPV4 情況下回傳4, IPV6情況下回傳6
var net = require('net'); console.log(net.isIP('1.1.1.1'));//4 console.log(net.isIP('1.1'));//0 console.log(net.isIP('AD80::ABAA:0000:00C2:0002'));//6
【net.isIPv4(input)】
如果輸入的位址為IPV4, 傳回true,否則回傳false
var net = require('net'); console.log(net.isIPv4('1.1.1.1'));//true console.log(net.isIPv4('1.1'));//false
【net.isIPv6(input)】
如果輸入的位址為IPV6, 回傳true,否則回傳false
var net = require('net'); console.log(net.isIPv6('1.1.1.1'));//true console.log(net.isIPv6('AD80::ABAA:0000:00C2:0002'));//true
【 net.createServer([options][, connectionListener])】
建立一個TCP 伺服器,參數如下
options allowHalfOpen: false(默认),如果为true,当另一端socket发送FIN包时socket不会自动发送FIN包。socket变为不可读但可写(半关闭) pauseOnConnect: false(默认),如果为true,当连接到来的时候相关联的socket将会暂停。它允许在初始进程不读取数据情况下,让连接在进程间传递。调用resume()从暂停的socket里读取数据 connectionListener 自动给 'connection' 事件创建监听器
var server = net.createServer(function() { });
【server.listen(port[, host][, backlog][, callback ])】
開始接受指定連接埠port和主機host的連線。如果忽略主機host,伺服器將會接受任何IPv4位址(INADDR_ANY)的直接連線。連接埠為0,則會分配一個隨機連接埠
積壓量(Backlog)為連接等待佇列的最大長度。實際長度由作業系統透過sysctl設定,例如linux上的tcp_max_syn_backlog和somaxconn。這個參數預設值是511
當伺服器被綁定時會觸發'listening'事件。最後一個參數callback將會作為'listening'事件的監聽器
有些使用者會遇到EADDRINUSE錯誤,它表示另一個伺服器已經運行在所要求的連接埠上。處理這個情況的方法是等一段時間後再重試
server.listen(6000);
【server.close([callback])】
伺服器停止接收新的連接,保持現有連接。當所有連線結束的時候伺服器會關閉,並會觸發'close'事件。你可以傳一個回呼函數來監聽'close'事件。如果存在,將會呼叫回呼函數,錯誤(如果有)作為唯一參數
【server.address()】
作業系統傳回綁定的位址、協定族名和伺服器連接埠。尋找哪個連接埠已經被系統綁定時,非常有用
[注意]在'listening' 事件觸發前,不要呼叫server.address()
server.listen(function() { //{ address: '::', family: 'IPv6', port: 53806 } console.log(server.address()); });
【server.maxConnections】
設定這個選項後,當伺服器連線數超過數量時拒絕新連線
一旦已經用child_process.fork() 方法將socket 傳送給子進程, 就不建議使用這個選項
【server.getConnections(callback)】
非同步取得伺服器目前活躍連線的數量。當socket 傳送給子程序後才有效;
回呼函數有2 個參數err 和count
server.getConnections(function(err,count){ console.log(count);//0 })
【事件listening】
當伺服器呼叫server.listen 綁定後會觸發
【事件connection】
{Socket object} 连接对象
當新連線建立後會被觸發。 socket 是net.Socket實例
【事件close】
伺服器關閉時會觸發
[注意]如果存在連接,這個事件不會被觸發直到所有的連接關閉
【事件error】
發生錯誤時觸發
【net.connect(options[, connectionListener ])】
【net.createConnection(options[, connectionListener])】
connect()的別名是createConnection()方法
該方法傳回一個新的' net.Socket',並連接到指定的位址和連接埠。當 socket 建立的時候,將會觸發 'connect' 事件。和'net.Socket'有相同的方法
對於TCP sockets,參數options如下
port: 客户端连接到 Port 的端口(必须) host: 客户端要连接到得主机。默认 'localhost' localAddress: 网络连接绑定的本地接口 localPort: 网络连接绑定的本地端口 family : IP 栈版本。默认 4
對於本地域socket,參數options如下
#path: 客户端连接到得路径(必须)
var client = net.connect({port: 5000}, function() {});
【new net.Socket([options])】
建構一個新的socket 物件
options 物件有以下預設值:
{ fd: null allowHalfOpen: false, readable: false, writable: false }
# # 參數fd允許指定一個存在的檔案描述子。將readable和(或)writable設為true,允許在這個socket上讀或寫(僅在參數fd有效時)
【socket.connect(port[, host][, connectListener])】
【socket.connect(path[, connectListener])】
使用傳入的socket開啟一個連線。如果指定了連接埠port和主機host,TCP socket將開啟socket。如果忽略參數host,則預設為localhost。如果指定了path,socket將會被指定路徑的unix socket 開啟
參數connectListener 將會作為監聽器新增至'connect' 事件
【socket.write(data[, encoding] [, callback])】
在socket上傳送資料。第二個參數指定了字串的編碼,預設是UTF8編碼
如果所有数据成功刷新到内核缓冲区,返回true。如果数据全部或部分在用户内存里,返回false。当缓冲区为空的时候会触发'drain'
当数据最终被完整写入的的时候,可选的callback参数会被执行,但不一定会马上执行
【socket.end([data][, encoding])】
半关闭socket。例如,它发送一个FIN包。可能服务器仍在发送数据。
如果参数data不为空,等同于调用socket.write(data,encoding)后再调用socket.end()
【socket.destroy()】
确保没有 I/O 活动在这个套接字上。只有在错误发生情况下才需要
【socket.pause()】
暂停读取数据。就是说,不会再触发 data 事件。对于控制上传非常有用
【socket.resume()】
调用 pause() 后想恢复读取数据
【socket.setTimeout(timeout[, callback])】
socket 闲置时间超过 timeout 毫秒后 ,将 socket 设置为超时。触发空闲超时事件时,socket 将会收到 'timeout'事件,但是连接不会被断开。用户必须手动调用 end() 或 destroy() 这个socket。
如果 timeout = 0, 那么现有的闲置超时会被禁用。可选的 callback 参数将会被添加成为 'timeout' 事件的一次性监听器
【socket.setNoDelay([noDelay])】
禁用纳格(Nagle)算法。默认情况下 TCP 连接使用纳格算法,在发送前他们会缓冲数据。将 noDelay 设置为 true 将会在调用 socket.write() 时立即发送数据。noDelay 默认值为 true
【socket.setKeepAlive([enable][, initialDelay])】
禁用/启用长连接功能,在发送第一个在闲置socket上的长连接probe之前,可选地设定初始延时。默认false
设定initialDelay(毫秒),来设定收到的最后一个数据包和第一个长连接probe之间的延时。将 initialDelay 设为0,将会保留默认(或者之前)的值。默认值为0
【socket.address()】
操作系统返回绑定的地址,协议族名和服务器端口。返回的对象有 3 个属性,比如{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
【socket.remoteAddress】
远程的 IP 地址字符串
【socket.remoteFamily】
远程IP协议族字符串
【socket.remotePort】
远程端口,数字表示
【socket.localAddress】
远程客户端正在连接的本地IP地址,字符串表示
【socket.localPort】
本地端口地址,数字表示
【socket.bytesRead】
接收的字节数
【socket.bytesWritten】
发送的字节数
【事件lookup】
在解析域名后,但在连接前,触发这个事件。对 UNIX sokcet 不适用
err {Error | Null} 错误对象 address {String} IP 地址。 family {String | Null} 地址类型
【事件connect】
当成功建立 socket 连接时触发、
【事件data】
{Buffer object}
当接收到数据时触发。参数 data 可以是 Buffer 或 String
当 Socket 触发一个 'data' 事件时,如果没有监听器,数据将会丢失
【事件end】
当 socket 另一端发送 FIN 包时,触发该事件
【事件timeout】
当 socket 空闲超时时触发,仅是表明 socket 已经空闲。用户必须手动关闭连接
【事件drain】
当写缓存为空得时候触发。可用来控制上传
【事件error】
错误发生时触发
【事件close】
had_error {Boolean} 如果 socket 传输错误,为 true
当 socket 完全关闭时触发。参数 had_error 是 boolean,它表示是否因为传输错误导致 socket 关闭
【服务器】
//server.js var net = require('net') ; var server = net.createServer(function(socket) { socket.write("Hi!\n"); socket.on("data", function(data) { console.log(data.toString()); }); socket.on("end", function() { console.log('有客户机下线了!!!'); }); socket.on('error', function() { console.log('发生意外错误!!!'); }); }) ; server.listen(8080) ;
【客户机】
//client.js var net = require('net') ; var client = net.connect({port: 8080},function(){ client.name = '客户机1'; client.write(client.name + ' 上线了!\n'); client.end(client.name + ' 下线了!\n'); client.on("data", function(data) { console.log(data.toString()); }); });
【服务器】
//chatServer.js var net = require('net'); var i = 0; //保存客户机 var clientList = []; var server = net.createServer(function(socket) { socket.name = '用户' + (++i); socket.write('【聊天室提示】欢迎' + socket.name + '\n'); //更新客户机数组 clientList.push(socket); function showClients(){ console.log('【当前在线用户】:'); for(var i=0;i<clientList.length;i++) { console.log(clientList[i].name); } } showClients(); socket.on("data", function(data) { //把当前连接的客户机的信息转发到其他客户机 for(var i=0;i<clientList.length;i++) { if(socket !== clientList[i]) { clientList[i].write('【' + socket.name + '】:' + data); } } }); socket.on("close", function() { //当前客户机下线时,将其从客户机数组中移除 clientList.splice(clientList.indexOf(socket), 1); showClients(); }); socket.on('error', function(err) { console.log(socket.name + '退出'); }); }); server.listen(8080) ;
【客户机】
//chatClient.js var net = require('net'); process.stdin.resume(); process.stdin.setEncoding('utf8'); var client = net.connect({port: 8080},function(){ console.log('【本机提示】登录到聊天室'); process.stdin.on('data',function(data){ client.write(data); }) client.on("data", function(data) { console.log(data.toString()); }); client.on('end', function() { console.log('【本机提示】退出聊天室'); process.exit(); }); client.on('error', function() { console.log('【本机提示】聊天室异常'); process.exit(); }); });
更多编程相关知识,请访问:编程入门!!
以上是淺談nodejs中的net模組的詳細內容。更多資訊請關注PHP中文網其他相關文章!