Node.js Net 模組

Node.js Net 模組提供了一些用於底層的網路通訊的小工具，包含了建立伺服器/客戶端的方法，我們可以通過以下方式引入該模組：

var net = require("net")

方法

• net.createServer([options][, connectionListener])建立一個 TCP 伺服器。 引數 connectionListener 自動給 'connection' 事件建立監聽器。

• net.connect(options[, connectionListener])返回一個新的 'net.Socket'，並連線到指定的地址和埠。 當 socket 建立的時候，將會觸發 'connect' 事件。

• net.createConnection(options[, connectionListener]) 建立一個到埠 port 和 主機 host的 TCP 連線。 host 預設為 'localhost'。

• net.connect(port[, host][, connectListener]) 建立一個埠為 port 和主機為 host的 TCP 連線 。host 預設為 'localhost'。 引數 connectListener 將會作為監聽器新增到 'connect' 事件。返回 'net.Socket'。

• net.createConnection(port[, host][, connectListener]) 建立一個埠為 port 和主機為 host的 TCP 連線 。host 預設為 'localhost'。 引數 connectListener 將會作為監聽器新增到 'connect' 事件。返回 'net.Socket'。

• net.connect(path[, connectListener]) 建立連線到 path 的 unix socket 。引數 connectListener 將會作為監聽器新增到 'connect' 事件上。返回 'net.Socket'。

• net.createConnection(path[, connectListener]) 建立連線到 path 的 unix socket 。引數 connectListener 將會作為監聽器新增到 'connect' 事件。返回 'net.Socket'。

• net.isIP(input) 檢測輸入的是否為 IP 地址。 IPV4 返回 4， IPV6 返回 6，其他情況返回 0。

• net.isIPv4(input) 如果輸入的地址為 IPV4， 返回 true，否則返回 false。

• net.isIPv6(input) 如果輸入的地址為 IPV6， 返回 true，否則返回 false。

net.Server

net.Server通常用於建立一個 TCP 或本地伺服器。

• server.listen(port[, host][, backlog][, callback]) 監聽指定埠 port 和 主機 host ac連線。 預設情況下 host 接受任何 IPv4 地址(INADDR_ANY)的直接連線。埠 port 為 0 時，則會分配一個隨機埠。

• server.listen(path[, callback]) 通過指定 path 的連線，啟動一個本地 socket 伺服器。

• server.listen(handle[, callback]) 通過指定控制代碼連線。

• server.listen(options[, callback]) options 的屬性：埠 port, 主機 host, 和 backlog, 以及可選引數 callback 函式, 他們在一起呼叫server.listen(port, [host], [backlog], [callback])。還有，引數 path 可以用來指定 UNIX socket。

• server.close([callback]) 伺服器停止接收新的連線，保持現有連線。這是非同步函式，當所有連線結束的時候伺服器會關閉，並會觸發 'close' 事件。

• server.address() 作業系統返回繫結的地址，協議族名和伺服器埠。

• server.unref() 如果這是事件系統中唯一一個活動的伺服器，呼叫 unref 將允許程式退出。

• server.ref() 與 unref 相反，如果這是唯一的伺服器，在之前被 unref 了的伺服器上呼叫 ref 將不會讓程式退出（預設行為）。如果伺服器已經被 ref，則再次呼叫 ref 並不會產生影響。

• server.getConnections(callback) 非同步獲取伺服器當前活躍連線的數量。當 socket 傳送給子程序後才有效；回撥函式有 2 個引數 err 和 count。

事件

• listening 當伺服器呼叫 server.listen 繫結後會觸發。

• connection 當新連線建立後會被觸發。socket 是 net.Socket例項。

• close 伺服器關閉時會觸發。注意，如果存在連線，這個事件不會被觸發直到所有的連線關閉。

net.Socket

net.Socket 物件是 TCP 或 UNIX Socket 的抽象。net.Socket 例項實現了一個雙工流介面。 他們可以在使用者建立客戶端(使用 connect())時使用, 或者由 Node 建立它們，並通過 connection 伺服器事件傳遞給使用者。

net.Socket事件

• lookup 在解析域名後，但在連線前，觸發這個事件。對 UNIX sokcet 不適用。

• connect 成功建立 socket 連線時觸發。

• data 當接收到資料時觸發。

• end 當 socket 另一端傳送 FIN 包時，觸發該事件。

• timeout 當 socket 空閒超時時觸發，僅是表明 socket 已經空閒。使用者必須手動關閉連線。

• drain 當寫快取為空得時候觸發。可用來控制上傳。

• error 錯誤發生時觸發。

• close 當 socket 完全關閉時觸發。引數 had_error 是布林值，它表示是否因為傳輸錯誤導致 socket 關閉。

屬性

net.Socket 提供了很多有用的屬性，便於控制 socket 互動：

方法

• new net.Socket([options]) 構造一個新的 socket 物件。

• socket.connect(path[, connectListener]) 開啟指定路徑的 unix socket。通常情況不需要使用 net.createConnection 開啟 socket。只有你實現了自己的 socket 時才會用到。

• socket.setEncoding([encoding]) 設定編碼

• socket.write(data[, encoding][, callback]) 在 socket 上傳送資料。第二個引數指定了字串的編碼，預設是 UTF8 編碼。

• socket.end([data][, encoding]) 半關閉 socket。例如，它傳送一個 FIN 包。可能伺服器仍在傳送資料。

• socket.destroy() 確保沒有 I/O 活動在這個套接字上。只有在錯誤發生情況下才需要。（處理錯誤等等）。

• socket.pause() 暫停讀取資料。就是說，不會再觸發 data 事件。對於控制上傳非常有用。

• socket.resume() 呼叫 pause() 後想恢復讀取資料。

• socket.setTimeout(timeout[, callback]) socket 閒置時間超過 timeout 毫秒後 ，將 socket 設定為超時。

• 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.unref() 如果這是事件系統中唯一一個活動的伺服器，呼叫 unref 將允許程式退出。如果伺服器已被 unref，則再次呼叫 unref 並不會產生影響。

• socket.ref() 與 unref 相反，如果這是唯一的伺服器，在之前被 unref 了的伺服器上呼叫 ref 將不會讓程式退出（預設行為）。如果伺服器已經被 ref，則再次呼叫 ref 並不會產生影響。