chrome.sockets.udp

說明

使用 chrome.sockets.udp API，透過 UDP 連線在網路上傳送及接收資料。這個 API 取代了先前在「socket」API 中找到的 UDP 功能。

資訊清單

您必須在資訊清單中宣告下列金鑰，才能使用這個 API。

"sockets"

類型

CreateInfo

屬性

  • socketId

    數字

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

DnsQueryType

Chrome 103 以上版本

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

列舉

"any"

"ipv4"

"ipv6"

ReceiveErrorInfo

屬性

  • resultCode

    數字

    基礎 recvfrom() 呼叫傳回的結果代碼。

  • socketId

    數字

    通訊端 ID。

ReceiveInfo

屬性

  • 資料

    ArrayBuffer

    UDP 封包內容 (截斷為目前的緩衝區空間)。

  • remoteAddress

    字串

    封包來源主機的位址。

  • remotePort

    數字

    封包來源主機的通訊埠。

  • socketId

    數字

    通訊端 ID。

SendInfo

屬性

  • bytesSent

    數字 選填

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

  • resultCode

    數字

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

SocketInfo

屬性

  • bufferSize

    數字 選填

    用於接收資料的緩衝區大小。如未明確指定緩衝區大小，則不會提供值。

  • localAddress

    字串 選填

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

  • localPort

    數字 選填

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

  • 名稱

    字串 選填

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

  • 已暫停

    布林值

    此標記用於註明是否禁止通訊端觸發 onReceive 事件。

  • 永久

    布林值

    這個標記會指出應用程式暫停時，通訊端是否保持開啟 (請參閱 SocketProperties.persistent)。

  • socketId

    數字

    通訊端 ID。

SocketProperties

屬性

  • bufferSize

    數字 選填

    用於接收資料的緩衝區大小。如果緩衝區太小，無法接收 UDP 封包，資料就會遺失。預設值為 4096。

  • 名稱

    字串 選填

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

  • 永久

    布林值 選填

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

方法

bind()

chrome.sockets.udp.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
): void

繫結通訊端的本機位址和通訊埠。如果是用戶端通訊端，建議使用通訊埠 0，讓平台選擇可用的通訊埠。

bind 作業成功完成後，只要 UDP 封包抵達指定的位址/通訊埠，系統就會引發 onReceive 事件，除非通訊端已暫停。

參數

  • socketId

    數字

    通訊端 ID。

  • 地址

    字串

    本機機器的位址。支援 DNS 名稱、IPv4 和 IPv6 格式。使用「0.0.0.0」可接受來自所有本機可用網路介面的封包。

  • 通訊埠

    數字

    本機電腦的通訊埠。使用「0」繫結至可用通訊埠。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

close()

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

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

參數

  • socketId

    數字

    通訊端 ID。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 121 以上版本

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

create()

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

使用指定屬性建立 UDP 通訊端。

參數

  • 屬性

    SocketProperties 選填

    通訊端屬性 (選用)。

  • callback

    函式 選填

    callback 參數如下： 

    (createInfo: CreateInfo) => void

傳回

  • Promise<CreateInfo>

    Chrome 121 以上版本

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

getInfo()

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

擷取指定通訊端的狀態。

參數

  • socketId

    數字

    通訊端 ID。

  • callback

    函式 選填

    callback 參數如下： 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      包含通訊端資訊的物件。

傳回

  • Promise<SocketInfo>

    Chrome 121 以上版本

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

getJoinedGroups()

Promise 
chrome.sockets.udp.getJoinedGroups(
  socketId: number,
  callback?: function,
): Promise<string[]>

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

參數

  • socketId

    數字

    通訊端 ID。

  • callback

    函式 選填

    callback 參數如下： 

    (groups: string[]) => void

    • 群組

      string[]

      通訊端加入的群組陣列。

傳回

  • Promise<string[]>

    Chrome 121 以上版本

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

getSockets()

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

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

參數

  • callback

    函式 選填

    callback 參數如下： 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      包含通訊端資訊的物件陣列。

傳回

  • Promise<SocketInfo[]>

    Chrome 121 以上版本

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

joinGroup()

chrome.sockets.udp.joinGroup(
  socketId: number,
  address: string,
  callback: function,
): void

加入多點傳播群組，並開始接收該群組的封包。呼叫這個方法前，通訊端必須繫結至本機通訊埠。

參數

  • socketId

    數字

    通訊端 ID。

  • 地址

    字串

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

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

leaveGroup()

chrome.sockets.udp.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
): void

離開先前使用 joinGroup 加入的多點傳播群組。只有在您打算繼續使用通訊端時，才需要呼叫這個方法，因為通訊端關閉時，OS 會自動執行這個方法。

離開群組後，路由器就不會將多點傳播資料圖傳送至本機主機，前提是主機上沒有其他程序仍加入群組。

參數

  • socketId

    數字

    通訊端 ID。

  • 地址

    字串

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

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

send()

chrome.sockets.udp.send(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
): void

將指定通訊端上的資料傳送至指定位址和通訊埠。呼叫這個方法前，通訊端必須繫結至本機通訊埠。

參數

  • socketId

    數字

    通訊端 ID。

  • 資料

    ArrayBuffer

    要傳送的資料。

  • 地址

    字串

    遠端機器的位址。

  • 通訊埠

    數字

    遠端機器的通訊埠。

  • dnsQueryType

    DnsQueryType 選填

    Chrome 103 以上版本

    位址解析偏好設定。

  • callback

    函式

    callback 參數如下： 

    (sendInfo: SendInfo) => void

    • sendInfo

      SendInfo

      send 方法的結果。

setBroadcast()

Chrome 44 以上版本 
chrome.sockets.udp.setBroadcast(
  socketId: number,
  enabled: boolean,
  callback: function,
): void

啟用或停用這個通訊端上的廣播封包。

參數

  • socketId

    數字

    通訊端 ID。

  • 已啟用

    布林值

    true 可啟用廣播封包，false 則可停用。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

setMulticastLoopbackMode()

chrome.sockets.udp.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
): void

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

注意：setMulticastLoopbackMode 的行為在 Windows 和 Unix 類系統之間略有不同。只有在同一主機上有多個應用程式加入同一個多點傳播群組，且多點傳播回送模式設定不同時，才會發生不一致的情況。在 Windows 上，關閉回送功能的應用程式不會「接收」回送封包；在類 Unix 系統上，關閉回送功能的應用程式不會將回送封包「傳送」至同一主機上的其他應用程式。請參閱 MSDN：https://learn.microsoft.com/en-us/windows/win32/winsock/ip-multicast-2

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

參數

  • socketId

    數字

    通訊端 ID。

  • 已啟用

    布林值

    指出是否要啟用回送模式。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

setMulticastTimeToLive()

chrome.sockets.udp.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
): void

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

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

參數

  • socketId

    數字

    通訊端 ID。

  • ttl

    數字

    存留時間值。

  • callback

    函式

    callback 參數如下： 

    (result: number) => void

    • 結果

      數字

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

setPaused()

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

暫停或取消暫停通訊端。暫停的通訊端無法觸發 onReceive 事件。

參數

  • socketId

    數字

    通訊端 ID。

  • 已暫停

    布林值

    用於指出是否要暫停或取消暫停的標記。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 121 以上版本

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

update()

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

更新通訊端屬性。

參數

  • socketId

    數字

    通訊端 ID。

  • 要更新的屬性。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 121 以上版本

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

事件

onReceive

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

為指定通訊端收到 UDP 封包時，系統會引發這個事件。

參數

onReceiveError

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

執行階段在通訊端位址和通訊埠等待資料時，如果發生網路錯誤，就會引發這個事件。這個事件引發後，通訊端會暫停，且在通訊端恢復前，不會再引發任何 onReceive 事件。

參數