chrome.sockets.tcpServer

說明

使用 chrome.sockets.tcpServer API 透過 TCP 連線建立伺服器應用程式。這項 API 取代了先前 chrome.socket API 中的 TCP 功能。

資訊清單

如要使用這項 API，必須在資訊清單中宣告下列鍵。

"sockets"

類型

AcceptErrorInfo

屬性

  • resultCode

    數字

    基礎網路呼叫傳回的結果代碼。

  • socketId

    數字

    伺服器通訊端 ID。

AcceptInfo

屬性

  • clientSocketId

    數字

    用戶端通訊端 ID，也就是新建立連線的通訊端 ID。這個通訊端 ID 只能與 chrome.sockets.tcp 命名空間的函式搭配使用。請注意，用戶端通訊端一開始會暫停，應用程式必須明確取消暫停，才能開始接收資料。

  • socketId

    數字

    伺服器通訊端 ID。

CreateInfo

屬性

  • socketId

    數字

    新建立的伺服器通訊端 ID。請注意，透過這個 API 建立的 Socket ID，與透過其他 API (例如已淘汰的 [socket](../socket/) API) 建立的 Socket ID 不相容。

SocketInfo

屬性

  • localAddress

    字串 選填

    如果通訊端正在監聽，則包含本機 IPv4/6 位址。

  • localPort

    號碼 選填

    如果插座正在監聽，則包含其本機通訊埠。

  • 名稱

    字串 選填

    與通訊端相關聯的應用程式定義字串。

  • 已暫停

    布林值

    這個旗標表示監聽插座上的連線要求，是透過 onAccept 事件調度，還是排入監聽佇列積壓工作。詳情請參閱 setPaused。預設值為「false」。

  • 永久

    布林值

    這個旗標指出卸載應用程式的事件頁面時，插座是否保持開啟狀態 (請參閱 SocketProperties.persistent)。預設值為「false」。

  • socketId

    數字

    插座 ID。

SocketProperties

屬性

  • 名稱

    字串 選填

    與通訊端相關聯的應用程式定義字串。

  • 永久

    布林值 選填

    這個旗標表示應用程式的事件頁面卸載時，插座是否保持開啟狀態 (請參閱「管理應用程式生命週期」)。預設值為「false」。載入應用程式後，先前以 persistent=true 開啟的任何通訊端都可以透過 getSockets 擷取。

方法

close()

Promise 
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
): Promise<void>

中斷連線並終結通訊端。建立的每個通訊端都應在使用後關閉。只要呼叫函式，插槽 ID 就會失效。不過，只有在叫用回呼時，才能保證插槽已關閉。

參數

  • socketId

    數字

    插座 ID。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

create()

Promise 
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

建立 TCP 伺服器通訊端。

參數

  • 資源

    SocketProperties optional

    插座屬性 (選用)。

  • callback

    函式 選用

    callback 參數如下： 

    (createInfo: CreateInfo) => void

傳回

  • Promise<CreateInfo>

    Chrome 121 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

disconnect()

Promise 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

中斷接聽通訊端，也就是停止接受新連線，並釋放通訊端繫結的位址/通訊埠。插座 ID 仍有效，例如可用於 listen，在新的連接埠和位址上接受連線。

參數

  • socketId

    數字

    插座 ID。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getInfo()

Promise 
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

擷取指定插座的狀態。

參數

  • socketId

    數字

    插座 ID。

  • callback

    函式 選用

    callback 參數如下： 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      包含通訊端資訊的物件。

傳回

  • Promise<SocketInfo>

    Chrome 121 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getSockets()

Promise 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

擷取應用程式目前開啟的通訊端清單。

參數

  • callback

    函式 選用

    callback 參數如下： 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      包含插座資訊的物件陣列。

傳回

  • Promise<SocketInfo[]>

    Chrome 121 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

listen()

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

在指定的通訊埠和位址監聽連線。如果連接埠/地址正在使用中，回呼會指出失敗。

參數

  • socketId

    數字

    插座 ID。

  • 地址

    字串

    本機的地址。

  • 通訊埠

    數字

    本機電腦的通訊埠。如果設為 0，系統會動態選擇可用通訊埠。您可以呼叫 getInfo，找出動態分配的通訊埠。

  • backlog

    號碼 選填

    通訊端接聽佇列的長度。預設值取決於作業系統 (SOMAXCONN)，可確保大多數應用程式的佇列長度合理。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

      基礎網路呼叫傳回的結果代碼。負值表示發生錯誤。

setPaused()

Promise 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

啟用或停用接聽插座，使其無法接受新連線。暫停時，接聽通訊端會接受新連線，直到後備佇列 (請參閱 listen 函式) 已滿，然後拒絕其他連線要求。只有在取消暫停通訊端時，才會引發 onAccept 事件。

參數

  • socketId

    數字

  • 已暫停

    布林值

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

update()

Promise 
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
): Promise<void>

更新通訊端屬性。

參數

  • socketId

    數字

    插座 ID。

  • 要更新的屬性。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

事件

onAccept

chrome.sockets.tcpServer.onAccept.addListener(
  callback: function,
)

連線至伺服器通訊端時引發的事件。

參數

onAcceptError

chrome.sockets.tcpServer.onAcceptError.addListener(
  callback: function,
)

當執行階段等待通訊端位址和連接埠上的新連線時發生網路錯誤，就會引發這個事件。引發這個事件後，插槽會設為 paused，且在插槽恢復前，不會再為這個插槽引發 onAccept 事件。

參數