説明
chrome.socket
API を使用して、TCP 接続と UDP 接続を使用してネットワーク経由でデータを送受信します。注: Chrome 33 以降、この API はサポートが終了し、sockets.udp
、sockets.tcp
、sockets.tcpServer
API の使用が推奨されます。
権限
socket
型
AcceptInfo
プロパティ
-
resultCode
数値
-
socketId
number(省略可)
受け入れられたソケットの ID。
CreateInfo
プロパティ
-
socketId
数値
新しく作成されたソケットの ID。
CreateOptions
NetworkInterface
プロパティ
-
address
文字列
利用可能な IPv4/6 アドレス。
-
name
文字列
アダプターの基盤となる名前。*nix では、通常、これは "eth0"、"lo" などです。
-
prefixLength
数値
プレフィックスの長さ
ReadInfo
プロパティ
-
data
ArrayBuffer
-
resultCode
数値
基になる read() 呼び出しから返された resultCode。
RecvFromInfo
プロパティ
-
address
文字列
リモートマシンのアドレス。
-
data
ArrayBuffer
-
ポート
数値
-
resultCode
数値
基になる recvfrom() 呼び出しから返された resultCode。
SecureOptions
プロパティ
-
tlsVersion
SocketInfo
プロパティ
-
接続済み
boolean
基盤となるソケットが接続されているかどうか。
tcp
ソケットの場合、リモートピアが切断されても、これは true のままです。ソケットに対する読み取りまたは書き込みはエラーとなり、このソケットをdisconnect()
を介して切断する必要があることをほのめかします。udp
ソケットの場合、パケットの読み書きにデフォルトのリモート アドレスが指定されているかどうかを表します。 -
localAddress
string(省略可)
基盤となるソケットがバインドまたは接続されている場合、そのローカル IPv4/6 アドレスが含まれます。
-
localPort
number(省略可)
基盤となるソケットがバインドまたは接続されている場合、そのローカルポートが含まれます。
-
peerAddress
string(省略可)
基盤となるソケットが接続されている場合、ピアの IPv4/6 アドレスが含まれます。
-
peerPort
number(省略可)
基盤となるソケットが接続されている場合、接続されているピアのポートが含まれます。
-
socketType
渡されたソケットのタイプ。これは
tcp
またはudp
です。
SocketType
Enum
"tcp"
TLSVersionConstraints
プロパティ
-
最高
string(省略可)
-
分
string(省略可)
TLS の最小許容バージョンと最大許容バージョン。指定できる値は
tls1.2
またはtls1.3
です。値
tls1
とtls1.1
はサポートされなくなりました。min
がこれらの値のいずれかに設定されている場合、通知なくtls1.2
にクランプされます。max
がこれらの値のいずれか、または認識できないその他の値に設定されている場合は、通知なく無視されます。
WriteInfo
プロパティ
-
bytesWritten
数値
送信されたバイト数、または負のエラーコード。
Methods
accept()
chrome.socket.accept(
socketId: number,
callback: function,
)
この方法は、TCP ソケットにのみ適用されます。このリスニング サーバー ソケットで接続が受け入れられたときに呼び出されるコールバック関数を登録します。Listen を最初に呼び出す必要があります。アクティブな承認コールバックがすでに存在する場合は、このコールバックが直ちに呼び出され、resultCode としてエラーが返されます。
パラメータ
-
socketId
数値
socketId。
-
callback
機能
callback
パラメータは次のようになります。(acceptInfo: AcceptInfo) => void
-
acceptInfo
-
bind()
chrome.socket.bind(
socketId: number,
address: string,
port: number,
callback: function,
)
ソケットのローカル アドレスをバインドします。現時点では、TCP ソケットはサポートされていません。
パラメータ
-
socketId
数値
socketId。
-
address
文字列
ローカルマシンのアドレス。
-
ポート
数値
ローカルマシンのポート。
-
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()
chrome.socket.create(
type: SocketType,
options?: CreateOptions,
callback?: function,
)
指定されたリモートマシンに接続する、指定されたタイプのソケットを作成します。
パラメータ
-
タイプ
作成するソケットのタイプ。
tcp
またはudp
を指定する必要があります。 -
オプション
CreateOptions 省略可
ソケットのオプション。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(createInfo: CreateInfo) => void
-
createInfo
-
戻り値
-
Promise<CreateInfo>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
destroy()
chrome.socket.destroy(
socketId: number,
)
ソケットを破棄します。作成されたソケットは使用後に破棄する必要があります。
パラメータ
-
socketId
数値
socketId。
disconnect()
chrome.socket.disconnect(
socketId: number,
)
ソケットを切断します。UDP ソケットの場合、disconnect
は動作しませんが、安全に呼び出すことができます。
パラメータ
-
socketId
数値
socketId。
getInfo()
chrome.socket.getInfo(
socketId: number,
callback?: function,
)
指定されたソケットの状態を取得します。
パラメータ
-
socketId
数値
socketId。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(result: SocketInfo) => void
-
件の結果
-
戻り値
-
Promise<SocketInfo>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
getJoinedGroups()
chrome.socket.getJoinedGroups(
socketId: number,
callback: function,
)
ソケットが現在参加しているマルチキャスト グループ アドレスを取得します。
パラメータ
-
socketId
数値
socketId。
-
callback
機能
callback
パラメータは次のようになります。(groups: string[]) => void
-
グループ
string[]
-
getNetworkList()
chrome.socket.getNetworkList(
callback?: function,
)
このシステムのローカル アダプタに関する情報を取得します。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。(result: NetworkInterface[]) => void
-
件の結果
-
戻り値
-
Promise<NetworkInterface[]>
Chrome 121 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
joinGroup()
chrome.socket.joinGroup(
socketId: number,
address: string,
callback: function,
)
マルチキャスト グループに参加して、そのグループからのパケットの受信を開始します。ソケットは UDP タイプで、このメソッドを呼び出す前にローカルポートにバインドされている必要があります。
パラメータ
-
socketId
数値
socketId。
-
address
文字列
参加するグループ アドレス。ドメイン名はサポートされていません。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
-
leaveGroup()
chrome.socket.leaveGroup(
socketId: number,
address: string,
callback: function,
)
joinGroup
を使用して以前に参加したマルチキャスト グループを残します。ソケットを破棄したり終了したりする前に、マルチキャスト グループから離れる必要はありません。これは OS によって自動的に呼び出されます。
グループから退会すると、ホスト上の他のプロセスがまだグループに参加していないと仮定して、ルーターからローカルホストにマルチキャスト データグラムを送信できなくなります。
パラメータ
-
socketId
数値
socketId。
-
address
文字列
終了するグループ アドレス。ドメイン名はサポートされていません。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
-
listen()
chrome.socket.listen(
socketId: number,
address: string,
port: number,
backlog?: number,
callback: function,
)
この方法は、TCP ソケットにのみ適用されます。指定されたポートとアドレスで接続をリッスンします。これにより実質的にはサーバー ソケットとなり、クライアント ソケットの機能(connect、read、write)はこのソケットでは使用できなくなります。
パラメータ
-
socketId
数値
socketId。
-
address
文字列
ローカルマシンのアドレス。
-
ポート
数値
ローカルマシンのポート。
-
バックログ
number(省略可)
ソケットのリッスン キューの長さ。
-
callback
機能
callback
パラメータは次のようになります。(result: number) => void
-
件の結果
数値
-
read()
chrome.socket.read(
socketId: number,
bufferSize?: number,
callback: function,
)
接続されている特定のソケットからデータを読み取ります。
パラメータ
-
socketId
数値
socketId。
-
bufferSize
number(省略可)
読み取りバッファのサイズ。
-
callback
機能
callback
パラメータは次のようになります。(readInfo: ReadInfo) => void
-
readInfo
-
recvFrom()
chrome.socket.recvFrom(
socketId: number,
bufferSize?: number,
callback: function,
)
指定された UDP ソケットからデータを受信します。
パラメータ
-
socketId
数値
socketId。
-
bufferSize
number(省略可)
受信バッファサイズ。
-
callback
機能
callback
パラメータは次のようになります。(recvFromInfo: RecvFromInfo) => void
-
recvFromInfo
-
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。
-
data
ArrayBuffer
書き込むデータ。
-
address
文字列
リモートマシンのアドレス。
-
ポート
数値
リモートマシンのポート。
-
callback
機能
callback
パラメータは次のようになります。(writeInfo: WriteInfo) => void
-
writeInfo
-
setKeepAlive()
chrome.socket.setKeepAlive(
socketId: number,
enable: boolean,
delay?: number,
callback: function,
)
TCP 接続のキープアライブ機能を有効または無効にします。
パラメータ
-
socketId
数値
socketId。
-
enable
boolean
true の場合、キープアライブ機能を有効にします。
-
delay
number(省略可)
最後に受信されたデータパケットから最初のキープアライブ プローブまでの遅延(秒)を設定します。デフォルトは 0 です。
-
callback
機能
callback
パラメータは次のようになります。(result: boolean) => void
-
件の結果
boolean
-
setMulticastLoopbackMode()
chrome.socket.setMulticastLoopbackMode(
socketId: number,
enabled: boolean,
callback: function,
)
ホストからマルチキャスト グループに送信されたマルチキャスト パケットをホストにループバックするかどうかを設定します。
注: setMulticastLoopbackMode
の動作は、Windows 系と Unix 系のシステムで若干異なります。不整合が発生するのは、同じホスト上の複数のアプリケーションが同じマルチキャスト グループに参加していて、マルチキャスト ループバック モードの設定が異なる場合のみです。Windows では、ループバックがオフのアプリケーションはループバック パケットを受信しません。Unix 系のシステムでは、ループバックがオフのアプリケーションは、同じホスト上の他のアプリケーションにループバック パケットを送信しません。MSDN をご覧ください: http://goo.gl/6vqbj
このメソッドを呼び出すためにマルチキャストの権限は必要ありません。
パラメータ
-
socketId
数値
socketId。
-
有効
boolean
ループバック モードを有効にするかどうかを指定します。
-
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
boolean
true の場合、Nagle のアルゴリズムを無効にします。
-
callback
機能
callback
パラメータは次のようになります。(result: boolean) => void
-
件の結果
boolean
-
write()
chrome.socket.write(
socketId: number,
data: ArrayBuffer,
callback: function,
)
接続されている特定のソケットにデータを書き込みます。