TCP クライアント/サーバ通信

フォーム |TCP| の後ろにいくつかの数字を持つ文字列です。デバイス名の数字部分は、デバイス識別子といいます。ポート番号が OPEN の parameters で指定されていない場合は、このデバイス識別子は一意の 5 桁の TCP ポート番号である必要があります。OPEN のパラメータでポート番号を指定している場合は (指定することをお勧めします)、1 つのジョブで使用するすべての TCP デバイス名が識別できる限り、このデバイス識別子には任意の一意の番号 (最大 2147483647) を指定できます。

オプション — 括弧で囲み、コロン (:) で区切ったデバイス・パラメータを 1 つ以上列記したものです。パラメータを省略する場合は、そのパラメータに該当する位置にコロン区切り文字を記述します (サーバ側で実行する OPEN コマンドでは、最初のパラメータは必ず省略することになります)。具体的なパラメータについては、以下で説明します。

最初のパラメータ (hostname) のみ指定する場合は、括弧を省略できます例えば、クライアント側で開く操作は OPEN "|TCP|7000":"127.0.0.1":10 となります。パラメータをまったく指定しない場合は括弧を省略できますが、区切り文字のコロンは記述する必要があります。例えば、サーバ側で開く操作は OPEN "|TCP|7000"::10 となります。

オプション — InterSystems IRIS が TCP デバイスを開こうとする最大秒数です。この間にファイルを開くことができない場合、$TEST を 0 に設定し、制御をプロセスに戻します。成功した場合、$TEST を 1 に設定します。クライアントからの Open コマンドにタイムアウトを組み込むと、サーバが別のクライアントと通信中に接続を試行した場合に、クライアント・システムが停止することを防ぎます。サーバで一度に開くことができる接続は 1 つのみです。

オプション — ObjectScript のすべての OPEN コマンドで、そのままサポートされます。TCP バインディング向けに、事前に定義されたニーモニック空間はありません。

既定値 ： 0

読み取りタイムアウトの動作を指定します。データを受信した際に TCP によってタイムアウト期間を再初期化するかどうかを決定します。/ABSTIMEOUT=0 (既定) の場合は、各時刻データの受信時にタイムアウトを元の値にリセットします。/ABSTIMEOUT もしくは /ABSTIMEOUT=1 の場合は、データを受信する間、タイムアウト期間のカウント・ダウンを続けます。

または ：

/ACC[=n]

既定値 ： 0

A モード・パラメータ文字に相当します。クライアント・ジョブからの接続が受け入れられるとすぐに、サーバでの初期の読み取りが長さ 0 の文字列で終了するように指定します。/ACCEPT と /ACCEPT=n の n が 0 以外の場合、A モードが有効になります。/ACCEPT=n の n が 0 の場合、A モードが無効になります。

既定値 ： 1

デバイスが閉じられている場合、出力バッファに残っているデータの処理を指定します。 /CLOSEFLUSH と /CLOSEFLUSH=n の n が 0 以外の場合、残りのデータをフラッシュします。/CLOSEFLUSH=n の n が 0 の場合、残りのデータを破棄します。

既定値 ： ""

ストリーム・データの圧縮タイプを指定します。圧縮タイプ ZLIB または ZSTD を有効にすることができます。/COMPRESS="" を指定すると、圧縮を無効にすることができます。/COMPRESS="zlib" は /GZIP=1 と同等です。文字列を圧縮するには、%SYSTEM.Util.Compress()Opens in a new tab を使用します。

既定値 ： 0

C モード・パラメータ文字に相当します。入出力を戻すキャリッジ・リターン処理を変更します。/CRLF と /CRLF=n の n が 0 以外の場合、C モードが有効になります。/CRLF=n の n が 0 の場合、C モードが無効になります。

または ：

/ESC[=n]

既定値 ： 0

E モード・パラメータ文字に相当します。入力ストリームでエスケープ・シーケンスを構文解析し、$ZB に配置するように指定します。/ESCAPE と /ESCAPE=n の n が 0 以外の場合、E モードが有効になります。/ESCAPE=n の n が 0 の場合、E モードが無効になります。

既定値 ： 1

GZIP と互換性のあるストリーム・データ圧縮を指定します。/GZIP を指定した場合、または /GZIP=n (n は 0 以外) を指定した場合、WRITE の発行時に圧縮、READ の発行時に解凍が有効になります。/GZIP=0 を指定した場合は、圧縮と解凍が無効になります。/GZIP=0 を発行して、圧縮/解凍を無効にする前に、$ZEOS 特殊変数をチェックして、ストリーム・データの読み込みが実行中でないことを確認してください。/GZIP 圧縮は、/IOTABLE を使用して構築した変換などの入出力変換には影響しません。これは、圧縮がその他すべての変換 (暗号化を除く) の後に適用され、解凍がその他すべての変換 (暗号化を除く) の前に適用されるためです。圧縮データで使用する WRITE に関する詳細は、"WRITE コントロール・コマンド" を参照してください。

または ：

/IOT[=name]

既定 ： name が指定されない場合、デバイスの既定の入出力変換テーブルを使用します。

デバイスの入出力変換テーブルを構築します。

既定 ： システムの既定

(Windows、AIX、Linux のみ) このデバイスに、システムの既定とは異なるキープアライブ・タイマを設定することができます。TCP 接続を保持する秒数を指定する整数。keepalivetime 位置パラメータと同じです。有効値は、30 ～ 432000 の範囲 (432,000 秒は 5 日) です。30 未満の値は、既定で 30 となります。省略した場合または 0 に設定した場合は、システムの既定値が使用されます。/NOKEEPALIVE を使用して、この設定を無効にできます。一度無効にすると、TCP デバイスが閉じるまで再度有効にすることはできません。

既定値 ： 1

パケットをまとめて送信するか、個々に送信するかを指定します。/NODELAY=1 (既定) に指定すると、パケット単位で直ちに転送されます。/NODELAY=0 に指定すると、最適化アルゴリズムを使用して TCP ドライバでパッケージが 1 つにまとめられます。これにより、パケット単位で見るとわずかな転送遅延が生じる場合がありますが、ネットワーク・トラフィックが減少することで、全体的なパフォーマンスの向上が望めます。/NODELAY に相当するモード・パラメータ文字はありません。/NODELAY は、/SENDIMMEDIATE との関係を考慮して使用する必要があります。

指定した場合、システム規模の TCP キープアライブ・タイマはこのデバイスに対して無効になります。InterSystems IRIS の既定では、TCP デバイスを開く際に、このタイマが有効になります。OPEN または USE で /NOKEEPALIVE オプションを使用すると、この既定がオーバーライドされます。/KEEPALIVE を使用して既定以外のキープアライブ・タイマを設定している場合は、/NOKEEPALIVE によりそのキープアライブ・タイマを無効にできます。一度キープアライブ・タイマを無効にすると、TCP デバイスを閉じるまで再度有効にすることはできません。"/KEEPALIVE" を参照してください。

既定値 ： 0

$X および $Y の処理なし ： /NOXY を指定した場合、または /NOXY=n (n は 0 以外の値) を指定した場合、$X および $Y の処理が無効になります。例えば、CSP などで、デバイスの $X/$Y を使用しない場合に、パフォーマンスを向上できます。これにより READ 操作および WRITE 操作のパフォーマンスを大幅に向上させることができます。このオプションは、スーパーサーバ・ワーカ・ジョブの既定の設定です。/NOXY=1 の場合、$X および $Y の変数値が不確定であるため、マージン処理 ($X に依存) は無効になります。/NOXY=0 の場合は、$X および $Y の処理が有効になります。これが既定です。/TCPNOXY は /NOXY の非推奨の同義語です。

既定値 ： 16

/ZEROCOPY で使用する出力バッファの数。既定の出力バッファ数は 16 です。出力バッファの最小数は 2 で、最大数は 128 です。n の値は 2 の累乗である必要があります。2 の累乗でない値を指定すると、2 の累乗に切り上げられます。

既定値 ： 0

P モード・パラメータ文字に相当します。これは WRITE ! (LF ターミネータ) または WRITE # (FF ターミネータ) の実行時に、出力にレコード・ターミネータ文字が埋め込まれることを指定します。/PAD と /PAD=n の n が 0 以外の場合、P モードが有効になります。/PAD=n の n が 0 の場合、P モードが無効になります。

または ：

/PAR=str

既定値なし。mode 位置パラメータに相当します (位置に依存しない方法でモード文字列を指定する方法を提供します)。

または ：

/POLLDISCON[=n]

切断の非同期監視を指定する D モード・パラメータ文字に相当します。/POLL または /POLL=1 は +D に相当し、/POLL=0 は -D に相当します。

既定値 ： 0

M モード・パラメータ文字に相当します。これは、P、S、T、E モード・パラメータ文字を指定する省略表現です。/PSTE と /PSTE=n の n が 0 以外の場合、P、S、T、E モードが有効になります。/PSTE=n の n が 0 の場合、これらのモードが無効になります。

または ：

/SEN[=n]

既定値 ： 0

Q モード・パラメータ文字に相当します。これは、即時送信モードを指定します。

または ：

/TLS="cfg[|pw] [|DNShost]"

既定値なし。

クライアントが指定した構成とサーバ要件に従い、SSL/TLS で保護された接続のネゴシエーションをデバイスで試行するようにクライアントから指定します。サーバとしてソケットを保護する場合は、サーバが指定した構成とクライアント要件に従い、SSL/TLS で保護された接続をサーバで必要とすることを指定します。

/SSL または /TLS キーワード・パラメータの値は、引用符付き文字列です。この文字列は、1 つ、2 つ、または 3 つのコンポーネントを '|' 文字で区切って持つことができます。

• cfg は、接続またはソケットの構成名を指定します。pw は、秘密鍵ファイルのオプションのパスワードを指定します。DNShost は、特定のサーバの完全修飾された DNS ホスト名を指定します。これは、サーバー ネーム インディケーション (SNI) の TLS Extension で使用します。

  この構成名は、OPEN または USE コマンド後の初回の I/O 動作時にのみ使用されます。それ以降の呼び出しは無視されます。/SSL="" または /TLS="" は無視されます。詳細は、インターシステムズの "TLS ガイド" を参照してください。

• pw (オプション) はローカルの秘密鍵ファイルのパスワードです。ユーザが昇格されて実行時にパスワードを入力するとき、これはインタラクティブなアプリケーション専用です。これは、永続的に格納されるパスワードでは使用しないでください。永続ストレージには Security.SSLConfigs.PrivateKeyPassword プロパティを使用します。

  重要 ： SSL/TLS を使用している新規の TCP 接続を開くときまたはそのような既存の接続を保護するときにパスワードを含める機能は、リアルタイムのインタラクティブを使用する場合にのみ有効です。保護していない秘密鍵パスワードを永続的に保存することは絶対に避けてください。そのようなパスワードを保存する必要がある場合は、Security.SSLConfigsOpens in a new tab クラスの PrivateKeyPassword プロパティを使用します。

• DNShost (オプション) は SSL クライアント専用で、特定のサーバの完全修飾された DNS ホスト名を指定します (サーバ名表示用)。 pw を省略した場合、プレースホルダ '|' 文字を指定する必要があります。

  サーバ名表示 (SNI) は、クライアントが要求しているホスト名をサーバに送信できるようにする機能です。これにより、複数のドメインを処理するサーバが、複数の証明書のうちの 1 つを選択して返すことができます。サーバは、クライアント上のホスト名の照合に一致するものを選択できます。

以下に示すのは、有効な /TLS キーワード・パラメータの例です。

/TLS="Client"
/TLS="Client|password"
/TLS="Client||www.intersystems.com"
/TLS="Client|password|www.intersystems.com" 

または ：

/STR[=n]

既定値 ： 0

S モード・パラメータ文字に相当します。TCP メッセージ範囲を保存しないデータを処理するストリーム・モードを指定します。/STREAM と /STREAM=n の n が 0 以外の場合、S モードが有効になります。/STREAM=n の n が 0 の場合、S モードが無効になります。

非推奨。/NOXY の同義語です。

既定値 ： 既定の受信バッファ・サイズ

受信キューのバッファ・サイズをバイト単位で設定します。TCP プロトコルでサイズの大きいウィンドウをサポートするために、バッファ・サイズを既定値から増やす場合に使用できます。ウィンドウのサイズが大きいと、長い遅延を持つリンクまたは広帯域リンクのパフォーマンスが向上します。適切な値については、使用しているオペレーティング・システムやハードウェアのドキュメントを参照してください。

既定値 ： 既定の送信バッファ・サイズ

送信キューのバッファ・サイズをバイト単位で設定します。TCP プロトコルでサイズの大きいウィンドウをサポートするために、バッファ・サイズを既定値から増やす場合に使用できます。ウィンドウのサイズが大きいと、長い遅延を持つリンクまたは広帯域リンクのパフォーマンスが向上します。適切な値については、使用しているオペレーティング・システムやハードウェアのドキュメントを参照してください。

または ：

/TER=str

既定値なし。

ユーザ定義のターミネータを構築する terminators 位置パラメータに相当します。

または ：

/TMO[=n]

既定値 ： 0

T モード・パラメータ文字に相当します。標準読み取りターミネータで CR、LF、FF を指定します。/TMODE と /TMODE=n の n が 0 以外の場合、T モードが有効になります。/TMODE=n の n が 0 の場合、T モードが無効になります。

または ：

/TRA[=n]

既定値 ： 1

/TRANSLATE を指定した場合、または /TRANSLATE=n の n が 0 以外の場合、デバイスの入出力変換が有効になります。/TRANSLATE=n の n が 0 の場合はデバイスの入出力変換が無効になります。

既定値 ： 0

W モード・パラメータ文字に相当します。出力バッファが、WRITE ! と WRITE # コマンドでフラッシュされないようにします。フラッシュは次の WRITE *-3 コマンドまで待機します。/WAIT と /WAIT=n の n が 0 以外の場合、W モードが有効になります。/WAIT=n の n が 0 の場合、W モードが無効になります。

既定値 ： -1

TCP の書き込み操作のためのタイムアウト (秒) を設定します。書き込みが n 秒以内で完了しない場合、InterSystems IRIS は <TCPWRITE> エラーを発行します。<TCPWRITE> エラーが発行された場合、ユーザ・アプリケーションで即座に TCP デバイスを閉じて、データ損失を防止する必要があります。InterSystems IRIS では、<TCPWRITE> エラーに続けて TCP の書き込み操作を試行することはありません。n の最小値はシステムによって異なります。n がプラットフォームの最小タイムアウト値よりも小さい場合、InterSystems IRIS ではプラットフォームの最小値が使用されます。n を 2 未満とすることはできません。既定 (-1) はタイムアウトの強制がないことを示しています。

または ：

/XYT[=name]

既定 ： name が指定されていない場合、デバイスの既定の $X/$Y アクション・テーブルを使用します。

デバイスの $X/$Y アクション・テーブルを構築します。/NOXY を参照してください。

既定値 ： 0

/ZEROCOPY または /ZEROCOPY=1 が指定されている場合、この TCP デバイスの ZEROCOPY 機能を有効にします。ZEROCOPY は send() 時に MSG_ZEROCOPY を利用するために、TCP デバイスの複数の出力バッファをサポートします。バッファが TCP スタックからの通知によって確認されるまで、TCP デバイスは出力バッファを再利用できません。TCP デバイスの出力バッファ数を設定するには、/OBCOUNT キーワードを使用します。/ZEROCOPY=0 が指定されている場合、この TCP デバイスの ZEROCOPY 機能を無効にします。MSG_ZEROCOPY は、Linux 4.15 以降でサポートされます。オペレーティング・システムで MSG_ZEROCOPY がサポートされない場合、TCP デバイスの ZEROCOPY は常に無効です。

接続の開始時に使用される指定ローカル・アドレスにバインドします。クライアントの場合は、InterSystems IRIS からの TCP/IP 接続をオープンするときに使用されるソース・アドレスです。サーバの場合は、InterSystems IRIS プロセスが TCP/IP 接続をオープンするときに接続を受け付ける IP アドレスです。/BINDTO=address は、接続で使用されるネットワーク・インタフェースを制御するために使用します。/BINDTO を指定した場合、または /BINDTO=”“ を指定した場合、以前に指定したアドレスは削除されます。指定された address が存在しない場合、OPEN コマンドはタイムアウトします。

(サーバのみ) 待ち受けポートへの複数のリモート接続を防止します。指定すると、最初の接続が受け入れられた後、待ち受けソケットが閉じられます。接続を試みる追加クライアントは、OPEN コマンドでタイムアウトします。

または ：

/CON=n

既定値 ： 5

queuesize 位置パラメータに相当します。サーバへの接続のために待機できるクライアント数を決定します。

または ：

/HOS=str

既定値なし。

hostname 位置パラメータに相当します。IP ホスト名か、IPv4 または IPv6 アドレス形式の IP アドレスを指定します。/USEIPV6 キーワードを使用して、使用するプロトコルを指定できます。IPv4 および IPv6 の形式に関する詳細は、"IPv6 アドレスの使用" を参照してください。

または ：

/IBU[=n]

既定値 ： 1024

ibufsiz 位置パラメータに相当します。ネットワークからデータを読み取り、アプリケーションに送信するまで保持する TCP 入力バッファのサイズを指定します。

または ：

/OBU[=n]

既定値 ： 1024

obufsiz 位置パラメータに相当します。連続する "SEND" 処理間でデータを保持する TCP 出力バッファのサイズを指定します。

既定値なし。

port 位置パラメータに相当します。接続に使用する TCP ポート番号あるいはサービス名です。

または ：

/SOC=n

既定値なし。

G モード・パラメータ文字に相当します。port 位置パラメータが、既に開いているデータ・ソケットのソケット記述子として解釈されます。このキーワードはソケット記述子の値を取得し、/PORT=n キーワードの代わりに使用されます (ソケット記述子は、InterSystems IRIS のコールインまたはコールアウト・メカニズムを使用して、C など他のプログラミング環境から ObjectScript に渡されます)。

既定値なし。

/USEIPV6 または /USEIPV6=1 が指定されている場合、インバウンド接続とアウトバウンド接続の両方に IPv6 アドレスを使用して、IPv6 システム・スイッチをオーバーライドします。/USEIPV6=0 が指定されている場合、インバウンド接続とアウトバウンド接続の両方に IPv4 アドレスを使用して、IPv6 システム・スイッチをオーバーライドします。

/USEIPV6 が指定されていない場合、IPv6 システム・スイッチが動作を制御します。IPv6 システム・スイッチが設定されている場合、アウトバウンド接続はまず IPv4 アドレスで接続を試みます。失敗した場合、IPv6 アドレスで接続を試みます。インバウンド接続では、TCP デバイスは IPv4 接続と IPv6 接続の両方をリッスンします。IPv6 が設定されていない場合、インバウンド接続とアウトバウンド接続の両方に IPv4 アドレスのみが使用されます。