chrome.sockets.udp

説明

chrome.sockets.udp API を使用して、UDP 接続を使用してネットワーク経由でデータを送受信します。この API は、以前の「ソケット」の UDP 機能に取って代わります。API

マニフェスト

この API を使用するには、次のキーをマニフェストで宣言する必要があります。

"sockets"

型

CreateInfo

プロパティ

  • socketId

    数値

    新しく作成されたソケットの ID。この API で作成されたソケット ID は、非推奨の [socket](../socket/) API など、他の API から作成されたソケット ID と互換性がないことに注意してください。

DnsQueryType

Chrome 103 以降

DNS 解決の設定。デフォルトは any で、IPv4 または IPv6 を返す可能性のある現在の OS 構成を使用します。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

    数値（省略可）

    基になるソケットがバインドされている場合、そのローカルポートが含まれます。

  • name

    文字列（省略可）

    ソケットに関連付けられている、アプリケーション定義の文字列。

  • 一時停止

    ブール値

    ソケットが onReceive イベントを発生させないようにブロックされているかどうかを示すフラグ。

  • 永続

    ブール値

    アプリが一時停止したときにソケットが開いたままになっているかどうかを示すフラグ（SocketProperties.persistent を参照）。

  • socketId

    数値

    ソケット ID。

SocketProperties

プロパティ

  • bufferSize

    数値（省略可）

    データの受信に使用されるバッファのサイズ。バッファが小さすぎて UDP パケットを受信できない場合、データは失われます。デフォルト値は 4096 です。

  • name

    文字列（省略可）

    ソケットに関連付けられている、アプリケーション定義の文字列。

  • 永続

    ブール値（省略可）

    アプリのイベントページがアンロードされたときにソケットが開いたままになっているかどうかを示すフラグ（アプリのライフサイクルを管理するをご覧ください）。デフォルト値は「false」です。アプリが読み込まれると、その前に persistent=true を指定して開いたソケットは getSockets でフェッチできます。

メソッド

bind()

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

ソケットのローカル アドレスとポートをバインドします。クライアント ソケットの場合は、ポート 0 を使用してプラットフォームで空きポートを選択できるようにすることをおすすめします。

bind オペレーションが正常に完了すると、ソケットが一時停止されていない限り、指定したアドレスまたはポートに UDP パケットが到着したときに onReceive イベントが発生します。

パラメータ

  • socketId

    数値

    ソケット ID。

  • 住所

    文字列

    ローカルマシンのアドレス。DNS 名、IPv4、IPv6 形式がサポートされています。「0.0.0.0」を使用してくださいすべてのローカル利用可能なネットワーク インターフェースからのパケットを受け入れます。

  • ポート

    数値

    ローカルマシンのポート。「0」を使用してください空きポートにバインドします

  • callback

    関数

    callback パラメータは次のようになります。 

    (result: number) => void

    • 件の結果

      数値

      基になるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。

close()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.sockets.udp.close(
  socketId: number,
  callback?: function,
)

ソケットを閉じ、ソケットがバインドされているアドレス/ポートを解放します。作成された各ソケットは使用後に閉じる必要があります。関数が呼び出されるとすぐにソケット ID は無効になります。ただし、コールバックが呼び出されたときにのみソケットが閉じることが保証されます。

パラメータ

  • socketId

    数値

    ソケット ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 121 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

create()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.sockets.udp.create(
  properties?: SocketProperties,
  callback?: function,
)

指定されたプロパティで UDP ソケットを作成します。

パラメータ

  • プロパティ

    SocketProperties オプション

    ソケットのプロパティ（省略可）。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      ソケット作成の結果。

戻り値

  • Promise&lt;CreateInfo&gt;

    Chrome 121 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getInfo()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.sockets.udp.getInfo(
  socketId: number,
  callback?: function,
)

指定したソケットの状態を取得します。

パラメータ

  • socketId

    数値

    ソケット ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      ソケット情報を含むオブジェクト。

戻り値

  • Promise&lt;SocketInfo&gt;

    Chrome 121 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getJoinedGroups()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.sockets.udp.getJoinedGroups(
  socketId: number,
  callback?: function,
)

ソケットが現在参加しているマルチキャスト グループ アドレスを取得します。

パラメータ

  • socketId

    数値

    ソケット ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (groups: string[]) => void

    • グループ

      string[]

      ソケットが参加したグループの配列。

戻り値

  • Promise&lt;string[]&gt;

    Chrome 121 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getSockets()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.sockets.udp.getSockets(
  callback?: function,
)

アプリケーションが所有する、現在開いているソケットのリストを取得します。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      ソケット情報を含むオブジェクトの配列。

戻り値

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

joinGroup()

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

マルチキャスト グループに参加し、そのグループからのパケットの受信を開始します。このメソッドを呼び出す前に、ソケットをローカルポートにバインドする必要があります。

パラメータ

  • socketId

    数値

    ソケット ID。

  • 住所

    文字列

    参加するグループ アドレス。ドメイン名はサポートされていません。

  • callback

    関数

    callback パラメータは次のようになります。 

    (result: number) => void

    • 件の結果

      数値

      基になるネットワーク呼び出しから返された結果コード。負の値はエラーを示します。

leaveGroup()

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

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,
)

指定されたソケット上のデータを、指定されたアドレスとポートに送信します。このメソッドを呼び出す前に、ソケットをローカルポートにバインドする必要があります。

パラメータ

  • 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,
)

このソケットでのブロードキャスト パケットを有効または無効にします。

パラメータ

  • socketId

    数値

    ソケット ID。

  • 有効

    ブール値

    ブロードキャスト パケットを有効にするには 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。

  • 有効

    ブール値

    ループバック モードを有効にするかどうかを指定します。

  • 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()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.sockets.udp.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

ソケットの一時停止または一時停止解除を行います。一時停止したソケットでは onReceive イベントを発生させることができません。

パラメータ

  • socketId

    数値

  • 一時停止

    ブール値

    一時停止するか一時停止解除するかを示すフラグ。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 121 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

update()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.sockets.udp.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

ソケットのプロパティを更新します。

パラメータ

  • socketId

    数値

    ソケット ID。

  • プロパティ

    SocketProperties

    更新するプロパティ。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <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 イベントはそれ以上発生しません。

パラメータ