chrome.sockets.tcp

說明

使用 chrome.sockets.tcp API 透過 TCP 連線，在網路上傳送及接收資料。這項 API 取代了先前 chrome.socket API 中的 TCP 功能。

資訊清單

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

"sockets"

類型

CreateInfo

屬性

  • socketId

    數字

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

DnsQueryType

Chrome 103 以上版本

DNS 解析偏好設定。預設為 any，並使用目前的 OS 設定，可能會傳回 IPv4 或 IPv6。ipv4 會強制使用 IPv4，ipv6 則會強制使用 IPv6。

列舉

「any」

「ipv4」

"ipv6"

ReceiveErrorInfo

屬性

  • resultCode

    數字

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

  • socketId

    數字

    插座 ID。

ReceiveInfo

屬性

  • 資料

    ArrayBuffer

    收到的資料，大小上限為 bufferSize。

  • socketId

    數字

    插座 ID。

SecureOptions

屬性

SendInfo

屬性

  • bytesSent

    號碼 選填

    傳送的位元組數 (如果 result == 0)

  • resultCode

    數字

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

SocketInfo

屬性

  • bufferSize

    號碼 選填

    用來接收資料的緩衝區大小。如果未明確指定緩衝區大小，系統就不會提供值。

  • 已連線。

    布林值

    此標記用於註明通訊端是否已連線至遠端對等互連裝置。

  • localAddress

    字串 選填

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

  • localPort

    號碼 選填

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

  • 名稱

    字串 選填

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

  • 已暫停

    布林值

    這個旗標表示連線的通訊端是否會阻止對等互連傳送更多資料 (請參閱 setPaused)。

  • peerAddress

    字串 選填

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

  • peerPort

    號碼 選填

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

  • 永久

    布林值

    此標記表示應用程式暫停時，插槽是否保持開啟狀態 (請參閱 SocketProperties.persistent)。

  • socketId

    數字

    插座 ID。

SocketProperties

屬性

  • bufferSize

    號碼 選填

    用來接收資料的緩衝區大小。預設值為 4096。

  • 名稱

    字串 選填

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

  • 永久

    布林值 選填

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

TLSVersionConstraints

屬性

  • max

    字串 選填

  • 分鐘

    字串 選填

    可接受的最低和最高 TLS 版本。支援的值為 tls1.2 或 tls1.3。

    系統已不再支援 tls1 和 tls1.1 值。如果 min 設為其中一個值，系統會自動將其箝制為 tls1.2。如果 max 設為其中一個值或任何其他無法辨識的值，系統會自動忽略。

方法

close()

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

關閉通訊端，並釋出通訊端繫結的位址/連接埠。建立的每個通訊端都應在使用後關閉。只要呼叫函式，插槽 ID 就會失效。不過，只有在叫用回呼時，才能保證插槽已關閉。

參數

  • socketId

    數字

    插座 ID。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

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

connect()

chrome.sockets.tcp.connect(
  socketId: number,
  peerAddress: string,
  peerPort: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
): void

將插座連線至遠端電腦。connect 作業順利完成後，系統會在收到對等互連裝置的資料時引發 onReceive 事件。如果執行階段在接收封包時發生網路錯誤，系統會引發 onReceiveError 事件，此時，除非呼叫 resume 方法，否則這個通訊端不會再引發 onReceive 事件。

參數

  • socketId

    數字

    插座 ID。

  • peerAddress

    字串

    遠端機器的位址。支援 DNS 名稱、IPv4 和 IPv6 格式。

  • peerPort

    數字

    遠端電腦的通訊埠。

  • dnsQueryType

    DnsQueryType 選用

    Chrome 103 以上版本

    地址解析偏好設定。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

create()

Promise 
chrome.sockets.tcp.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.tcp.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

中斷通訊端連線。

參數

  • socketId

    數字

    插座 ID。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

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

getInfo()

Promise 
chrome.sockets.tcp.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.tcp.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

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

參數

  • callback

    函式 選用

    callback 參數如下： 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

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

傳回

  • Promise<SocketInfo[]>

    Chrome 121 以上版本

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

secure()

chrome.sockets.tcp.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
): void

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

參數

  • socketId

    數字

    要使用的現有已連線通訊端。

  • 選項

    SecureOptions optional

    TLS 連線的限制和參數。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

send()

chrome.sockets.tcp.send(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
): void

傳送指定 TCP 通訊端的資料。

參數

  • socketId

    數字

    插座 ID。

  • 資料

    ArrayBuffer

    要傳送的資料。

  • callback

    函式

    callback 參數如下： 

    (sendInfo: SendInfo) => void

    • sendInfo

      SendInfo

      send 方法的結果。

setKeepAlive()

chrome.sockets.tcp.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
): void

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

參數

  • socketId

    數字

    插座 ID。

  • 啟用

    布林值

    如為 true，則啟用 Keep-Alive 功能。

  • delay

    號碼 選填

    設定最後收到的資料封包與第一個存活探測之間的延遲秒數。預設值為 0。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

setNoDelay()

chrome.sockets.tcp.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
): void

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

參數

  • socketId

    數字

    插座 ID。

  • noDelay

    布林值

    如為 true，則停用 Nagle 演算法。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

setPaused()

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

啟用或停用應用程式接收對等互連裝置訊息的功能。預設值為「false」。應用程式通常會暫停通訊端，藉此限制對等互連傳送的資料。暫停通訊端時，系統不會引發 onReceive 事件。連線並取消暫停通訊端後，系統會在收到訊息時再次引發 onReceive 事件。

參數

  • socketId

    數字

  • 已暫停

    布林值

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

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

update()

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

更新通訊端屬性。

參數

  • socketId

    數字

    插座 ID。

  • 要更新的屬性。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 121 以上版本

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

事件

onReceive

chrome.sockets.tcp.onReceive.addListener(
  callback: function,
)

當特定通訊端收到資料時，系統會引發事件。

參數

onReceiveError

chrome.sockets.tcp.onReceiveError.addListener(
  callback: function,
)

執行階段等待通訊端位址和連接埠上的資料時發生網路錯誤，就會引發這個事件。一旦引發這個事件，插槽就會設為 paused，且不會再為這個插槽引發 onReceive 事件。

參數