説明
chrome.sockets.udp
API を使用して、UDP 接続を使用してネットワーク経由でデータを送受信します。この API は、以前の「socket」API で見られた UDP 機能に代わるものです。
マニフェスト
型
CreateInfo
プロパティ
-
socketId
数値
新しく作成されたソケットの ID。この API から作成されたソケット ID は、非推奨の
[
socket](../socket/)
API など、他の API から作成されたソケット ID と互換性がありません。
DnsQueryType
DNS 解決の設定。デフォルトは any
で、現在の OS 構成を使用します(IPv4 または IPv6 を返す場合があります)。ipv4
は IPv4 を、ipv6
は IPv6 を強制します。
Enum
「ipv4」
「ipv6」
ReceiveErrorInfo
プロパティ
-
resultCode
数値
基になる recvfrom() 呼び出しから返された結果コード。
-
socketId
数値
ソケット ID。
ReceiveInfo
プロパティ
-
data
ArrayBuffer
UDP パケットの内容(現在のバッファサイズに切り捨てられます)。
-
remoteAddress
文字列
パケットの送信元ホストのアドレス。
-
remotePort
数値
パケットの送信元ホストのポート。
-
socketId
数値
ソケット ID。
SendInfo
プロパティ
-
bytesSent
number(省略可)
送信されたバイト数(結果 == 0 の場合)
-
resultCode
数値
基盤となるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。
SocketInfo
プロパティ
-
bufferSize
number(省略可)
データの受信に使用されるバッファのサイズ。バッファサイズが明示的に指定されていない場合、値は提供されません。
-
localAddress
string(省略可)
基盤となるソケットがバインドされている場合、ローカル IPv4/6 アドレスが含まれます。
-
localPort
number(省略可)
基盤となるソケットがバインドされている場合、そのローカルポートが含まれます。
-
name
string(省略可)
ソケットに関連付けられたアプリケーション定義の文字列。
-
一時停止
boolean
ソケットでの onReceive イベントの呼び出しがブロックされているかどうかを示すフラグ。
-
永続
boolean
アプリが一時停止されたときにソケットが開いたままかどうかを示すフラグ(
SocketProperties.persistent
を参照)。 -
socketId
数値
ソケット識別子。
SocketProperties
プロパティ
-
bufferSize
number(省略可)
データの受信に使用されるバッファのサイズ。バッファが小さすぎて UDP パケットを受信できない場合、データが失われるデフォルト値は 4096 です。
-
name
string(省略可)
ソケットに関連付けられたアプリケーション定義の文字列。
-
永続
ブール値(省略可)
アプリケーションのイベントページがアンロードされたときにソケットが開いたままになっているかどうかを示すフラグ(アプリのライフサイクルを管理するを参照)。デフォルト値は「false」です。アプリが読み込まれると、以前に persistent=true で開かれたソケットを
getSockets
で取得できます。
Methods
bind()
chrome.sockets.udp.bind(
socketId: number,
address: string,
port: number,
callback: function,
)
ソケットのローカル アドレスとポートをバインドします。クライアント ソケットの場合は、プラットフォームが空きポートを選択できるように、ポート 0 を使用することをおすすめします。
bind
オペレーションが正常に完了すると、ソケットが一時停止されていない限り、UDP パケットが指定されたアドレス/ポートに到着すると onReceive
イベントが発生します。
パラメータ
-
socketId
数値
ソケット ID。
-
address
文字列
ローカルマシンのアドレス。DNS 名、IPv4 および IPv6 の形式がサポートされています。すべてのローカルの利用可能なネットワーク インターフェースからパケットを受信するには、「0.0.0.0」を使用します。
-
ポート
数値
ローカルマシンのポート。空きポートにバインドするには「0」を使用します。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
基盤となるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。
-
close()
chrome.sockets.udp.close(
socketId: number,
callback?: function,
)
ソケットを閉じ、ソケットがバインドされているアドレス/ポートを解放します。作成された各ソケットは、使用後に閉じる必要があります。ソケット ID は、関数が呼び出されるとすぐに無効になります。ただし、ソケットはコールバックが呼び出されたときにのみ閉じられることが保証されます。
パラメータ
-
socketId
数値
ソケット ID。
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
create()
chrome.sockets.udp.create(
properties?: SocketProperties,
callback?: function,
)
指定されたプロパティで UDP ソケットを作成します。
パラメータ
-
プロパティ
SocketProperties 省略可
ソケットのプロパティ(省略可)。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(createInfo: CreateInfo) => void
-
createInfo
ソケット作成の結果。
-
戻り値
-
Promise<CreateInfo>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
getInfo()
chrome.sockets.udp.getInfo(
socketId: number,
callback?: function,
)
指定されたソケットの状態を取得します。
パラメータ
-
socketId
数値
ソケット ID。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(socketInfo: SocketInfo) => void
-
socketInfo
ソケット情報を含むオブジェクト。
-
戻り値
-
Promise<SocketInfo>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
getJoinedGroups()
chrome.sockets.udp.getJoinedGroups(
socketId: number,
callback?: function,
)
ソケットが現在参加しているマルチキャスト グループ アドレスを取得します。
パラメータ
-
socketId
数値
ソケット ID。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(groups: string[]) => void
-
グループ
string[]
ソケットが参加したグループの配列。
-
戻り値
-
Promise<string[]>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
getSockets()
chrome.sockets.udp.getSockets(
callback?: function,
)
アプリケーションが所有する現在開いているソケットのリストを取得します。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。(socketInfos: SocketInfo[]) => void
-
socketInfos
ソケット情報を含むオブジェクトの配列。
-
戻り値
-
Promise<SocketInfo[]>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
joinGroup()
chrome.sockets.udp.joinGroup(
socketId: number,
address: string,
callback: function,
)
マルチキャスト グループに参加し、そのグループからのパケットの受信を開始します。このメソッドを呼び出す前に、ソケットをローカルポートにバインドする必要があります。
パラメータ
-
socketId
数値
ソケット ID。
-
address
文字列
参加するグループ アドレス。ドメイン名はサポートされていません。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
基盤となるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。
-
leaveGroup()
chrome.sockets.udp.leaveGroup(
socketId: number,
address: string,
callback: function,
)
以前に joinGroup
を使用して参加したマルチキャスト グループを残します。呼び出しは、ソケットが閉じられたときに OS によって自動的に行われるため、後からソケットを使用し続ける予定がある場合にのみ必要です。
グループから退会すると、ホスト上の他のプロセスがまだグループに参加していないと仮定して、ルーターからローカルホストにマルチキャスト データグラムを送信できなくなります。
パラメータ
-
socketId
数値
ソケット ID。
-
address
文字列
終了するグループ アドレス。ドメイン名はサポートされていません。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
基盤となるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。
-
send()
chrome.sockets.udp.send(
socketId: number,
data: ArrayBuffer,
address: string,
port: number,
dnsQueryType?: DnsQueryType,
callback: function,
)
指定されたソケット上のデータを、指定されたアドレスとポートに送信します。このメソッドを呼び出す前に、ソケットをローカルポートにバインドする必要があります。
パラメータ
-
socketId
数値
ソケット ID。
-
data
ArrayBuffer
送信するデータ。
-
address
文字列
リモートマシンのアドレス。
-
ポート
数値
リモートマシンのポート。
-
dnsQueryType
DnsQueryType 省略可
Chrome 103 以降アドレス解決の設定。
-
callback
機能
callback
パラメータは次のようになります。(sendInfo: SendInfo) => void
-
sendInfo
send
メソッドの結果。
-
setBroadcast()
chrome.sockets.udp.setBroadcast(
socketId: number,
enabled: boolean,
callback: function,
)
このソケットでのブロードキャスト パケットを有効または無効にします。
パラメータ
-
socketId
数値
ソケット ID。
-
有効
boolean
ブロードキャスト パケットを有効にする場合は
true
、無効にする場合はfalse
にします。 -
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
基盤となるネットワーク呼び出しから返された結果コード。
-
setMulticastLoopbackMode()
chrome.sockets.udp.setMulticastLoopbackMode(
socketId: number,
enabled: boolean,
callback: function,
)
ホストからマルチキャスト グループに送信されたマルチキャスト パケットをホストにループバックするかどうかを設定します。
注: setMulticastLoopbackMode
の動作は、Windows 系と Unix 系のシステムで若干異なります。不整合が発生するのは、同じホスト上の複数のアプリケーションが同じマルチキャスト グループに参加していて、マルチキャスト ループバック モードの設定が異なる場合のみです。Windows では、ループバックがオフのアプリケーションはループバック パケットを受信しません。Unix 系のシステムでは、ループバックがオフのアプリケーションは、同じホスト上の他のアプリケーションにループバック パケットを送信しません。MSDN をご覧ください: http://goo.gl/6vqbj
このメソッドを呼び出すためにマルチキャストの権限は必要ありません。
パラメータ
-
socketId
数値
ソケット ID。
-
有効
boolean
ループバック モードを有効にするかどうかを指定します。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
基盤となるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。
-
setMulticastTimeToLive()
chrome.sockets.udp.setMulticastTimeToLive(
socketId: number,
ttl: number,
callback: function,
)
マルチキャスト グループに送信されるマルチキャスト パケットの有効期間を設定します。
このメソッドを呼び出すためにマルチキャストの権限は必要ありません。
パラメータ
-
socketId
数値
ソケット ID。
-
ttl
数値
有効期間の値。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
基盤となるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。
-
setPaused()
chrome.sockets.udp.setPaused(
socketId: number,
paused: boolean,
callback?: function,
)
ソケットを一時停止または一時停止解除します。一時停止されたソケットによる onReceive
イベントの呼び出しはブロックされます。
パラメータ
-
socketId
数値
-
一時停止
boolean
一時停止するか一時停止解除するかを示すフラグ。
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
update()
chrome.sockets.udp.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
ソケットのプロパティを更新します。
パラメータ
-
socketId
数値
ソケット ID。
-
プロパティ
更新するプロパティ。
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
イベント
onReceive
chrome.sockets.udp.onReceive.addListener(
callback: function,
)
指定されたソケットで UDP パケットが受信されたときに発生するイベント。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。(info: ReceiveInfo) => void
-
情報
-
onReceiveError
chrome.sockets.udp.onReceiveError.addListener(
callback: function,
)
ランタイムがソケットのアドレスとポートでデータを待機している間にネットワーク エラーが発生すると、イベントが発生します。このイベントが発生するとソケットは一時停止され、ソケットが再開されるまでこのソケットに関する onReceive
イベントは発生しません。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。(info: ReceiveErrorInfo) => void