chrome.socket

說明

使用 chrome.socket API 透過 TCP 和 UDP 連線透過網路傳送及接收資料。注意：自 Chrome 33 版起，這個 API 已淘汰，並改用 sockets.udp、sockets.tcp 和 sockets.tcpServer API。

權限

socket

類型

AcceptInfo

屬性

  • resultCode

    數字

  • socketId

    編號 選填

    接受的通訊端 ID。

CreateInfo

屬性

  • socketId

    數字

    新建立的通訊端的 ID。

CreateOptions

NetworkInterface

屬性

  • 地址

    字串

    可用的 IPv4/6 位址。

  • 名稱

    字串

    轉接器的基礎名稱。在 *nix 上，通常會是「eth0」、「lo」等等。

  • prefixLength

    數字

    前置字串長度

ReadInfo

屬性

  • 資料

    ArrayBuffer

  • resultCode

    數字

    基礎 read() 呼叫傳回的 resultCode。

RecvFromInfo

屬性

  • 地址

    字串

    遠端電腦的位址。

  • 資料

    ArrayBuffer

  • 通訊埠

    數字

  • resultCode

    數字

    基礎 recvfrom() 呼叫傳回的 resultCode。

SecureOptions

屬性

SocketInfo

屬性

  • 已連線。

    布林值

    是否已連線至基礎通訊端。

    如果是 tcp 通訊端，即使遠端對等端連線中斷，此設定仍為 true。讀取或寫入通訊端可能會導致錯誤，指出這個通訊端應透過 disconnect() 中斷連線。

    若是 udp 通訊端，這只是表示是否已指定預設的遠端位址供讀取及寫入封包。

  • localAddress

    string optional

    如果基礎通訊端已繫結或已連線，則包含其本機 IPv4/6 位址。

  • localPort

    編號 選填

    如果基礎通訊端已繫結或已連線，則包含其本機通訊埠。

  • peerAddress

    string optional

    如果基礎通訊端已連線，會包含對等點的 IPv4/6 位址。

  • peerPort

    編號 選填

    如果基礎通訊端已連線，則包含已連線對等點的通訊埠。

  • socketType

    SocketType

    傳遞的通訊端類型。會是 tcp 或 udp。

SocketType

列舉

「TCP」：

"udp"

TLSVersionConstraints

屬性

  • 最高

    string optional

  • 分鐘

    string optional

    可接受的傳輸層安全標準 (TLS) 最高和最低版本。支援的值為 tls1.2 或 tls1.3。

    不再支援 tls1 和 tls1.1 值。如果將 min 設為其中一個值，則會自動限制為 tls1.2。如果將 max 設為其中一個值，或任何其他無法辨識的值，系統會直接忽略而不顯示任何通知。

WriteInfo

屬性

  • bytesWritten

    數字

    傳送的位元組數或負數錯誤代碼。

方法

accept()

chrome.socket.accept(
  socketId: number,
  callback: function,
)

這個方法僅適用於 TCP 通訊端。註冊在這個監聽伺服器通訊端接受連線時要呼叫的回呼函式。必須先呼叫收聽。如果已有有效的接受回呼，系統會立即叫用這個回呼，並顯示 resultCode

參數

  • socketId

    數字

    socketId。

  • 回呼

    函式

    callback 參數如下所示： 

    (acceptInfo: AcceptInfo) => void

bind()

chrome.socket.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
)

與通訊端的本機位址繫結。它目前不支援 TCP 通訊端。

參數

  • socketId

    數字

    socketId。

  • 地址

    字串

    本機電腦的位址。

  • 通訊埠

    數字

    本機電腦的通訊埠。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

connect()

chrome.socket.connect(
  socketId: number,
  hostname: string,
  port: number,
  callback: function,
)

將通訊端連線至遠端電腦 (用於 tcp 通訊端)。如果是 udp 通訊端，這會設定預設位址，做為 read() 和 write() 呼叫傳送及讀取封包的預設位址。

參數

  • socketId

    數字

    socketId。

  • 主機名稱

    字串

    遠端電腦的主機名稱或 IP 位址。

  • 通訊埠

    數字

    遠端電腦的通訊埠。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

create()

Promise 
chrome.socket.create(
  type: SocketType,
  options?: CreateOptions,
  callback?: function,
)

建立指定類型的通訊端，這個通訊端會連線至指定遠端電腦。

參數

  • 類型

    SocketType

    要建立的通訊端類型。必須為 tcp 或 udp。

  • 選項

    CreateOptions 選用

    通訊端選項。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (createInfo: CreateInfo) => void

傳回

  • Promise<CreateInfo>

    Chrome 121 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

destroy()

chrome.socket.destroy(
  socketId: number,
)

刪除通訊端。每個已建立的通訊端都應在使用後刪除。

參數

  • socketId

    數字

    socketId。

disconnect()

chrome.socket.disconnect(
  socketId: number,
)

中斷通訊端。針對 UDP 通訊端，disconnect 是非作業，但可以安全呼叫。

參數

  • socketId

    數字

    socketId。

getInfo()

Promise 
chrome.socket.getInfo(
  socketId: number,
  callback?: function,
)

擷取指定通訊端的狀態。

參數

  • socketId

    數字

    socketId。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (result: SocketInfo) => void

傳回

  • Promise<SocketInfo>

    Chrome 121 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

getJoinedGroups()

chrome.socket.getJoinedGroups(
  socketId: number,
  callback: function,
)

取得通訊端目前加入的多點傳播群組位址。

參數

  • socketId

    數字

    socketId。

  • 回呼

    函式

    callback 參數如下所示： 

    (groups: string[]) => void

    • 群組

      string[]

getNetworkList()

Promise 
chrome.socket.getNetworkList(
  callback?: function,
)

擷取這個系統上的本機轉接器相關資訊。

參數

傳回

  • Promise<NetworkInterface[]>

    Chrome 121 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

joinGroup()

chrome.socket.joinGroup(
  socketId: number,
  address: string,
  callback: function,
)

加入多點傳播群組並開始接收來自該群組的封包。通訊端必須是 UDP 類型，且必須先繫結至本機通訊埠，才能呼叫這個方法。

參數

  • socketId

    數字

    socketId。

  • 地址

    字串

    要加入的群組地址。不支援網域名稱。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

leaveGroup()

chrome.socket.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
)

退出先前使用 joinGroup 加入的多點傳播群組。在刪除通訊端或退出通訊端之前，不需要離開多點傳播群組。OS 會自動呼叫此指令。

離開群組會讓路由器無法將多點傳播資料元傳送至本機主機，假設主機上沒有其他程序仍加入群組。

參數

  • socketId

    數字

    socketId。

  • 地址

    字串

    要退出的群組地址。不支援網域名稱。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

listen()

chrome.socket.listen(
  socketId: number,
  address: string,
  port: number,
  backlog?: number,
  callback: function,
)

這個方法僅適用於 TCP 通訊端。監聽指定通訊埠和位址的連線。這樣一來，這個通訊端就無法再使用到伺服器通訊端，而且這個通訊端無法再使用用戶端通訊端函式 (連線、讀取、寫入)。

參數

  • socketId

    數字

    socketId。

  • 地址

    字串

    本機電腦的位址。

  • 通訊埠

    數字

    本機電腦的通訊埠。

  • 待處理工作量

    編號 選填

    通訊端的監聽佇列長度。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

read()

chrome.socket.read(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

這個外掛程式能從指定連線通訊端讀取資料。

參數

  • socketId

    數字

    socketId。

  • bufferSize

    編號 選填

    讀取緩衝區空間。

  • 回呼

    函式

    callback 參數如下所示： 

    (readInfo: ReadInfo) => void

recvFrom()

chrome.socket.recvFrom(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

接收來自指定 UDP 通訊端的資料。

參數

  • socketId

    數字

    socketId。

  • bufferSize

    編號 選填

    接收的緩衝區空間。

  • 回呼

    函式

    callback 參數如下所示： 

    (recvFromInfo: RecvFromInfo) => void

secure()

chrome.socket.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
)

透過已連線的 TCP 用戶端通訊端啟動 TLS 用戶端連線。

參數

  • socketId

    數字

    要使用的連線通訊端。

  • 選項

    SecureOptions 選用

    TLS 連線的限制和參數。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

sendTo()

chrome.socket.sendTo(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  callback: function,
)

這個外掛程式能將指定 UDP 通訊端的資料傳送至指定位址和通訊埠。

參數

  • socketId

    數字

    socketId。

  • 資料

    ArrayBuffer

    要寫入的資料。

  • 地址

    字串

    遠端電腦的位址。

  • 通訊埠

    數字

    遠端電腦的通訊埠。

  • 回呼

    函式

    callback 參數如下所示： 

    (writeInfo: WriteInfo) => void

setKeepAlive()

chrome.socket.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
)

啟用或停用 TCP 連線的保持運作功能。

參數

  • socketId

    數字

    socketId。

  • 啟用

    布林值

    如為 true，請啟用保持運作功能。

  • delay

    編號 選填

    設定最近一次接收的資料封包和第一次保持運作探測之間的延遲時間 (以秒為單位)。預設值為 0。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: boolean) => void

    • 結果

      布林值

setMulticastLoopbackMode()

chrome.socket.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)

設定從主機傳送至多點傳播群組的多點傳播封包是否會送回主機。

注意：setMulticastLoopbackMode 的行為在 Windows 和 Unix 類系統上稍有不同。只有當同一主機上的多個應用程式加入同一個多點傳播群組，同時在多點傳播回送模式下套用不同設定時，才會出現不一致的情況。在 Windows 中，關閉回送功能的應用程式不會接收回送封包；在 Unix 類系統上時，關閉回送功能的應用程式將不會傳送回送封包至同一主機上的其他應用程式。請參閱 MSDN：http://goo.gl/6vqbj

呼叫這個方法不需要多點傳播權限。

參數

  • socketId

    數字

    socketId。

  • 已啟用

    布林值

    表示是否要啟用回送模式。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

setMulticastTimeToLive()

chrome.socket.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)

設定傳送至多點傳播群組的多點傳送封包的存留時間。

呼叫這個方法不需要多點傳播權限。

參數

  • socketId

    數字

    socketId。

  • 文字轉語音

    數字

    存留時間值。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: number) => void

    • 結果

      數字

setNoDelay()

chrome.socket.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
)

設定或清除 TCP 連線的 TCP_NODELAY。設定 TCP_NODELAY 時，系統將停用 Nagle 的演算法。

參數

  • socketId

    數字

    socketId。

  • noDelay

    布林值

    如果設為 true，系統會停用 Nagle 的演算法。

  • 回呼

    函式

    callback 參數如下所示： 

    (result: boolean) => void

    • 結果

      布林值

write()

chrome.socket.write(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
)

這個外掛程式能在指定的連線通訊端上寫入資料。

參數

  • socketId

    數字

    socketId。

  • 資料

    ArrayBuffer

    要寫入的資料。

  • 回呼

    函式

    callback 參數如下所示： 

    (writeInfo: WriteInfo) => void