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 で、現在の OS 構成を使用します（IPv4 または IPv6 を返す場合があります）。ipv4 は IPv4 を、ipv6 は IPv6 を強制します。

Enum

「ipv4」

「ipv6」

ReceiveErrorInfo

プロパティ

  • resultCode

    数値

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

  • socketId

    数値

    ソケット識別子。

ReceiveInfo

プロパティ

  • data

    ArrayBuffer

    受信したデータ（最大サイズは bufferSize）。

  • socketId

    数値

    ソケット識別子。

SecureOptions

プロパティ

SendInfo

プロパティ

  • bytesSent

    number（省略可）

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

  • resultCode

    数値

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

SocketInfo

プロパティ

  • bufferSize

    number（省略可）

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

  • 接続済み

    boolean

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

  • localAddress

    string（省略可）

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

  • localPort

    number（省略可）

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

  • name

    string（省略可）

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

  • 一時停止

    boolean

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

  • peerAddress

    string（省略可）

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

  • peerPort

    number（省略可）

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

  • 永続

    boolean

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

  • socketId

    数値

    ソケット識別子。

SocketProperties

プロパティ

  • bufferSize

    number（省略可）

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

  • name

    string（省略可）

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

  • 永続

    ブール値（省略可）

    アプリケーションのイベントページがアンロードされたときにソケットが開いたままになっているかどうかを示すフラグ（アプリのライフサイクルを管理するを参照）。デフォルト値は「false」です。アプリが読み込まれると、以前に persistent=true で開かれたソケットを getSockets で取得できます。

TLSVersionConstraints

プロパティ

  • 最高

    string（省略可）

  • 分

    string（省略可）

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

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

Methods

close()

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

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

パラメータ

  • socketId

    数値

    ソケット識別子。

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<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

    数値

    ソケット識別子。

  • peerAddress

    文字列

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

  • peerPort

    数値

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

  • dnsQueryType

    DnsQueryType 省略可

    Chrome 103 以降

    アドレス解決の設定。

  • callback

    機能

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

    (result: number)=>void

    • 件の結果

      数値

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

create()

Promise 
chrome.sockets.tcp.create(
  properties?: SocketProperties,
  callback?: function,
)

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

パラメータ

  • プロパティ

    SocketProperties 省略可

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

  • callback

    関数（省略可）

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

    (createInfo: CreateInfo)=>void

    • createInfo

      CreateInfo

      ソケット作成の結果。

戻り値

  • Promise<CreateInfo>

    Chrome 121 以降

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

disconnect()

Promise 
chrome.sockets.tcp.disconnect(
  socketId: number,
  callback?: function,
)

ソケットを切断します。

パラメータ

  • socketId

    数値

    ソケット識別子。

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    Chrome 121 以降

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

getInfo()

Promise 
chrome.sockets.tcp.getInfo(
  socketId: number,
  callback?: function,
)

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

パラメータ

  • socketId

    数値

    ソケット識別子。

  • callback

    関数（省略可）

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

    (socketInfo: SocketInfo)=>void

    • socketInfo

      SocketInfo

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

戻り値

  • Promise<SocketInfo>

    Chrome 121 以降

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

getSockets()

Promise 
chrome.sockets.tcp.getSockets(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    (socketInfos: SocketInfo[])=>void

    • socketInfos

      SocketInfo[]

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

戻り値

  • Promise<SocketInfo[]>

    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

    数値

    ソケット識別子。

  • data

    ArrayBuffer

    送信するデータ。

  • callback

    機能

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

    (sendInfo: SendInfo)=>void

    • sendInfo

      SendInfo

      send メソッドの結果。

setKeepAlive()

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

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

パラメータ

  • socketId

    数値

    ソケット識別子。

  • enable

    boolean

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

  • delay

    number（省略可）

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

  • callback

    機能

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

    (result: number)=>void

    • 件の結果

      数値

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

setNoDelay()

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

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

パラメータ

  • socketId

    数値

    ソケット識別子。

  • noDelay

    boolean

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

  • callback

    機能

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

    (result: number)=>void

    • 件の結果

      数値

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

setPaused()

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

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

パラメータ

  • socketId

    数値

  • 一時停止

    boolean

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    Chrome 121 以降

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

update()

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

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

パラメータ

  • socketId

    数値

    ソケット識別子。

  • プロパティ

    SocketProperties

    更新するプロパティ。

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<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 イベントが生成されなくなります。

パラメータ