chrome.socket

説明

chrome.socket API を使用して、TCP 接続と UDP 接続を使用してネットワーク経由でデータを送受信します。注: sockets.udp API、sockets.tcp API、sockets.tcpServer API の導入に伴い、Chrome 33 以降、この API のサポートは終了しています。

権限

socket

型

AcceptInfo

プロパティ

  • resultCode

    数値

  • socketId

    数値（省略可）

    受け入れられるソケットの ID。

CreateInfo

プロパティ

  • socketId

    数値

    新しく作成されたソケットの ID。

CreateOptions

NetworkInterface

プロパティ

  • 住所

    文字列

    使用可能な IPv4/6 アドレス。

  • name

    文字列

    アダプタの基本名。*nix では、通常、"eth0"、"lo" などになります。

  • prefixLength

    数値

    プレフィックスの長さ

ReadInfo

プロパティ

  • データ

    ArrayBuffer

  • resultCode

    数値

    基になる read() 呼び出しから返された resultCode です。

RecvFromInfo

プロパティ

  • 住所

    文字列

    リモートマシンのアドレス。

  • データ

    ArrayBuffer

  • ポート

    数値

  • resultCode

    数値

    基になる recvfrom() 呼び出しから返された resultCode。

SecureOptions

プロパティ

SocketInfo

プロパティ

  • 接続済み

    ブール値

    基になるソケットが接続されているかどうか。

    tcp ソケットの場合、リモートピアが切断されても true のままです。その後、ソケットの読み書きでエラーが発生することがあり、このソケットを disconnect() を介して切断する必要があります。

    udp ソケットの場合、パケットの読み取りと書き込みにデフォルトのリモート アドレスが指定されているかどうかを表します。

  • localAddress

    文字列（省略可）

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

  • localPort

    数値（省略可）

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

  • peerAddress

    文字列（省略可）

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

  • peerPort

    数値（省略可）

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

  • socketType

    SocketType

    渡されたソケットの型。値は tcp または udp です。

SocketType

列挙型

「tcp」

"udp"

TLSVersionConstraints

プロパティ

  • 最大

    文字列（省略可）

  • 分

    文字列（省略可）

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

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

WriteInfo

プロパティ

  • bytesWritten

    数値

    送信されたバイト数、または負のエラーコード。

メソッド

accept()

chrome.socket.accept(
  socketId: number,
  callback: function,
)

この方法は TCP ソケットにのみ適用されます。このリスニング サーバー ソケットで接続が受け入れられたときに呼び出されるコールバック関数を登録します。最初に Listen を呼び出す必要があります。アクティブな承認コールバックがすでに存在する場合、このコールバックはすぐに呼び出され、resultCode としてエラーが返されます。

パラメータ

  • socketId

    数値

    socketId。

  • callback

    関数

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

    (acceptInfo: AcceptInfo) => void

bind()

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

ソケットのローカル アドレスをバインドします。現在、TCP ソケットはサポートされていません。

パラメータ

  • socketId

    数値

    socketId。

  • 住所

    文字列

    ローカルマシンのアドレス。

  • ポート

    数値

    ローカルマシンのポート。

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

connect()

chrome.socket.connect(
  socketId: number,
  hostname: string,
  port: number,
  callback: function,
)

ソケットをリモートマシンに接続します（tcp ソケットの場合）。udp ソケットの場合、read() と write() の呼び出しで送受信されるパケットのデフォルトのアドレスを設定します。

パラメータ

  • socketId

    数値

    socketId。

  • hostname

    文字列

    リモートマシンのホスト名または IP アドレス。

  • ポート

    数値

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

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

create()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.socket.create(
  type: SocketType,
  options?: CreateOptions,
  callback?: function,
)

指定したリモートマシンに接続する、指定したタイプのソケットを作成します。

パラメータ

  • type

    SocketType

    作成するソケットのタイプ。tcp または udp にする必要があります。

  • オプション

    CreateOptions（省略可）

    ソケット オプション。

  • callback

    関数（省略可）

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

    (createInfo: CreateInfo) => void

戻り値

  • Promise&lt;CreateInfo&gt;

    Chrome 121 以降

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

destroy()

chrome.socket.destroy(
  socketId: number,
)

ソケットを破棄します。作成した各ソケットは使用後に破棄する必要があります。

パラメータ

  • socketId

    数値

    socketId。

disconnect()

chrome.socket.disconnect(
  socketId: number,
)

ソケットを切断します。UDP ソケットの場合、disconnect は非オペレーションですが、安全に呼び出せます。

パラメータ

  • socketId

    数値

    socketId。

getInfo()

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

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

パラメータ

  • socketId

    数値

    socketId。

  • callback

    関数（省略可）

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

    (result: SocketInfo) => void

戻り値

  • Promise&lt;SocketInfo&gt;

    Chrome 121 以降

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

getJoinedGroups()

chrome.socket.getJoinedGroups(
  socketId: number,
  callback: function,
)

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

パラメータ

  • socketId

    数値

    socketId。

  • callback

    関数

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

    (groups: string[]) => void

    • グループ

      string[]

getNetworkList()

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

このシステムのローカル アダプターに関する情報を取得します。

パラメータ

  • callback

    関数（省略可）

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

    (result: NetworkInterface[]) => void

戻り値

  • Promise&lt;NetworkInterface[]&gt;

    Chrome 121 以降

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

joinGroup()

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

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

パラメータ

  • socketId

    数値

    socketId。

  • 住所

    文字列

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

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

leaveGroup()

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

以前に joinGroup を使用して参加したマルチキャスト グループを退出します。ソケットの破棄や終了の前にマルチキャスト グループから離れる必要はありません。これは OS によって自動的に呼び出されます。

グループから退会すると、ホスト上の他のプロセスがまだグループに参加していないと仮定して、ルーターがローカルホストにマルチキャスト データグラムを送信できなくなります。

パラメータ

  • socketId

    数値

    socketId。

  • 住所

    文字列

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

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

listen()

chrome.socket.listen(
  socketId: number,
  address: string,
  port: number,
  backlog?: number,
  callback: function,
)

この方法は TCP ソケットにのみ適用されます。指定されたポートとアドレスで接続をリッスンします。実質的にはこれがサーバー ソケットとなり、クライアント ソケット関数（接続、読み取り、書き込み）はこのソケットで使用できなくなります。

パラメータ

  • socketId

    数値

    socketId。

  • 住所

    文字列

    ローカルマシンのアドレス。

  • ポート

    数値

    ローカルマシンのポート。

  • バックログ

    数値（省略可）

    ソケットのリッスン キューの長さ。

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

read()

chrome.socket.read(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

指定された接続済みソケットからデータを読み取ります。

パラメータ

  • socketId

    数値

    socketId。

  • bufferSize

    数値（省略可）

    読み取りバッファサイズ。

  • callback

    関数

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

    (readInfo: ReadInfo) => void

recvFrom()

chrome.socket.recvFrom(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

指定された UDP ソケットからデータを受信します。

パラメータ

  • socketId

    数値

    socketId。

  • bufferSize

    数値（省略可）

    受信バッファサイズ。

  • callback

    関数

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

    (recvFromInfo: RecvFromInfo) => void

secure()

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

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

パラメータ

  • socketId

    数値

    使用する接続ソケット。

  • オプション

    SecureOptions（省略可）

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

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

sendTo()

chrome.socket.sendTo(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  callback: function,
)

指定された UDP ソケット上のデータを、指定されたアドレスとポートに送信します。

パラメータ

  • socketId

    数値

    socketId。

  • データ

    ArrayBuffer

    書き込むデータ。

  • 住所

    文字列

    リモートマシンのアドレス。

  • ポート

    数値

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

  • callback

    関数

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

    (writeInfo: WriteInfo) => void

setKeepAlive()

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

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

パラメータ

  • socketId

    数値

    socketId。

  • 有効にする

    ブール値

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

  • delay

    数値（省略可）

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

  • callback

    関数

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

    (result: boolean) => void

    • 件の結果

      ブール値

setMulticastLoopbackMode()

chrome.socket.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)

ホストからマルチキャスト グループに送信されたマルチキャスト パケットをホストにループバックするかどうかを設定します。

注: setMulticastLoopbackMode の動作は、Windows と Unix 系のシステムで若干異なります。この不整合が発生するのは、同じホスト上の複数のアプリケーションが、同じマルチキャスト グループに参加していて、マルチキャスト ループバック モードの設定が異なる場合のみです。Windows では、ループバックがオフになっているアプリケーションはループバック パケットを受信しません。一方、Unix 系のシステムでは、ループバックがオフになっているアプリケーションは、同じホスト上の他のアプリケーションにループバック パケットを送信しません。MSDN をご覧ください: http://goo.gl/6vqbj

このメソッドを呼び出すのに、マルチキャスト権限は必要ありません。

パラメータ

  • socketId

    数値

    socketId。

  • 有効

    ブール値

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

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

setMulticastTimeToLive()

chrome.socket.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)

マルチキャスト グループに送信されるマルチキャスト パケットの有効期間を設定します。

このメソッドを呼び出すのに、マルチキャスト権限は必要ありません。

パラメータ

  • socketId

    数値

    socketId。

  • ttl

    数値

    有効期間の値。

  • callback

    関数

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

    (result: number) => void

    • 件の結果

      数値

setNoDelay()

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

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

パラメータ

  • socketId

    数値

    socketId。

  • noDelay

    ブール値

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

  • callback

    関数

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

    (result: boolean) => void

    • 件の結果

      ブール値

write()

chrome.socket.write(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
)

指定された接続ソケットにデータを書き込みます。

パラメータ

  • socketId

    数値

    socketId。

  • データ

    ArrayBuffer

    書き込むデータ。

  • callback

    関数

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

    (writeInfo: WriteInfo) => void