chrome.sockets.tcp

説明

chrome.sockets.tcp API を使用して、TCP 接続を使用してネットワーク経由でデータを送受信します。この API は、chrome.socket API に以前あった TCP 機能よりも優先されます。

マニフェスト

この 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

    数値

    基になるネットワーク呼び出しから返された結果コード。

  • socketId

    数値

    ソケット ID。

ReceiveInfo

プロパティ

  • データ

    ArrayBuffer

    受信データ。最大サイズは bufferSize です。

  • socketId

    数値

    ソケット ID。

SecureOptions

プロパティ

SendInfo

プロパティ

  • bytesSent

    数値（省略可）

    送信されたバイト数（結果 == 0 の場合）

  • resultCode

    数値

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

SocketInfo

プロパティ

  • bufferSize

    数値（省略可）

    データの受信に使用されるバッファのサイズ。バッファサイズが明示的に指定されていない場合、値は提供されません。

  • 接続済み

    ブール値

    ソケットがリモートピアに接続されているかどうかを示すフラグ。

  • localAddress

    文字列（省略可）

    基になるソケットが接続されている場合、ローカルの IPv4/6 アドレスが含まれます。

  • localPort

    数値（省略可）

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

  • name

    文字列（省略可）

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

  • 一時停止

    ブール値

    接続されたソケットがピアの追加データの送信をブロックするかどうかを示すフラグ（setPaused を参照）。

  • peerAddress

    文字列（省略可）

    基盤となるソケットが接続されている場合、ピア/ IPv4/6 アドレスが含まれます。

  • peerPort

    数値（省略可）

    基盤となるソケットが接続されている場合、ピアポートが含まれます。

  • 永続

    ブール値

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

  • socketId

    数値

    ソケット ID。

SocketProperties

プロパティ

  • bufferSize

    数値（省略可）

    データの受信に使用されるバッファのサイズ。デフォルト値は 4096 です。

  • name

    文字列（省略可）

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

  • 永続

    ブール値（省略可）

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

TLSVersionConstraints

プロパティ

  • 最大

    文字列（省略可）

  • 分

    文字列（省略可）

    TLS の最小許容バージョンと最大許容バージョン。指定できる値は tls1.2 または tls1.3 です。

    値 tls1 と tls1.1 はサポートされなくなりました。min がこれらの値のいずれかに設定されている場合、通知なく tls1.2 にクランプされます。max がこれらの値のいずれか、または認識できない他の値に設定されている場合、その値は通知なく無視されます。

メソッド

close()

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

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

パラメータ

  • socketId

    数値

    ソケット ID。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 121 以降

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

connect()

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

ソケットをリモートマシンに接続します。connect オペレーションが正常に完了すると、ピアからデータを受信したときに onReceive イベントが発生します。ランタイムがパケットを受信中にネットワーク エラーが発生すると、onReceiveError イベントが発生します。この時点で、resume メソッドが呼び出されるまで、このソケットの onReceive イベントは発生しません。

パラメータ

  • socketId

    数値

    ソケット ID。

  • peerAddress

    文字列

    リモートマシンのアドレス。DNS 名、IPv4、IPv6 形式がサポートされています。

  • peerPort

    数値

    リモートマシンのポート。

  • dnsQueryType

    DnsQueryType 省略可

    Chrome 103 以降

    アドレス解決の設定。

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

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

create()

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

TCP ソケットを作成します。

パラメータ

  • プロパティ

    SocketProperties オプション

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

  • callback

    関数（省略可）

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

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      ソケット作成の結果。

戻り値

  • Promise&lt;CreateInfo&gt;

    Chrome 121 以降

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

disconnect()

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

ソケットを切断します。

パラメータ

  • socketId

    数値

    ソケット ID。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 121 以降

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

getInfo()

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

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

パラメータ

  • socketId

    数値

    ソケット ID。

  • callback

    関数（省略可）

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

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

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

戻り値

  • Promise&lt;SocketInfo&gt;

    Chrome 121 以降

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

getSockets()

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

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

パラメータ

  • callback

    関数（省略可）

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

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

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

戻り値

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 以降

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

secure()

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

接続された TCP クライアント ソケットを介して TLS クライアント接続を開始します。

パラメータ

  • socketId

    数値

    使用する既存の接続済みソケット。

  • オプション

    SecureOptions（省略可）

    TLS 接続の制約とパラメータ。

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

send()

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

指定された 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,
)

TCP 接続のキープアライブ機能を有効または無効にします。

パラメータ

  • socketId

    数値

    ソケット ID。

  • 有効にする

    ブール値

    true の場合、キープアライブ機能を有効にします。

  • delay

    数値（省略可）

    最後に受信したデータパケットから最初のキープアライブ プローブまでの遅延（秒）を設定します。デフォルトは 0 です。

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

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

setNoDelay()

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

TCP 接続の TCP_NODELAY を設定またはクリアします。TCP_NODELAY を設定すると、Nagle のアルゴリズムは無効になります。

パラメータ

  • socketId

    数値

    ソケット ID。

  • noDelay

    ブール値

    true の場合、Nagle のアルゴリズムを無効にします。

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

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

setPaused()

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

アプリケーションによるピアからのメッセージ受信を有効または無効にします。デフォルト値は「false」です。ソケットの一時停止は通常、アプリケーションがピアから送信されたデータを抑制するために使用されます。ソケットが一時停止すると、onReceive イベントは発生しません。ソケットが接続され、一時停止を解除すると、メッセージを受信すると、再び onReceive イベントが発生します。

パラメータ

  • socketId

    数値

  • 一時停止

    ブール値

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 121 以降

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

update()

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

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

パラメータ

  • socketId

    数値

    ソケット ID。

  • プロパティ

    SocketProperties

    更新するプロパティ。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 121 以降

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

イベント

onReceive

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

特定のソケットでデータを受信したときに発生するイベント。

パラメータ

  • callback

    関数

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

    (info: ReceiveInfo) => void

onReceiveError

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

ランタイムがソケット アドレスとポートでデータを待機中にネットワーク エラーが発生したときに発生するイベント。このイベントが発生すると、ソケットは paused に設定され、このソケットの onReceive イベントは発生しません。

パラメータ