ソケットコネクタドキュメントリファレンス

設定


リスナ設定

リスナソケットへの AbstractSocketConfig の実装。

パラメータ

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。この名前は後から参照できます。

x 

Connection (接続)

この設定に指定できる接続型。

x 

Default Encoding (デフォルトのエンコード)

String (文字列)

文字列のシリアル化に使用されるデフォルトのエンコード。SocketOperations#send(RequesterConnection, RequesterConfig, Object, String, String, Message) 操作で String 型をシリアル化するとき、エンコードのパラメータが指定されていない場合は、このエンコードが使用されます。

また、SocketWorker でも SocketListener ソースによって送信される返信をエンコードするのにも使用されます。

 

接続種別

TCP リスナ

SocketListener によって使用される TcpListenerConnection のインスタンスを提供する ConnectionProvider。

パラメータ
名前 説明 デフォルト値 必須

Protocol (プロトコル)

データがどのように読み書きされるのかを認識している TcpProtocol。指定しない場合、SafeProtocol が使用されます。

 

TLS Configuration (TLS 設定)

TLS

このパラメータがある場合、新しい SSL 接続の受け入れに、単純な TCP ServerSocket の代わりに SSLServerSocket が使用されることを暗黙に示しています。

 

Port (ポート)

Number (数値)

接続のポート番号

x 

Host (ホスト)

String (文字列)

接続のホスト名

x 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

Disable Validation (検証の無効化)

Boolean (ブール)

接続の検証を無効にします。

 

Send Buffer Size (送信バッファサイズ)

Number (数値)

データの送信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Receive Buffer Size (受信バッファサイズ)

Number (数値)

データの受信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Client Timeout (クライアントタイムアウト)

Number (数値)

ソケットに SO_TIMEOUT 値を設定します。blocking 操作で失敗する前にソケットが待機する時間 (ミリ秒) を示します。0 (デフォルト値) は無期限に待機することを意味します。

 

Reuse Address (アドレスの再利用)

Boolean (ブール)

設定すると (デフォルト)、バインドする前にソケットに SO_REUSEADDRESS が設定されます。ソケットを再利用するときに発生する「address already in use (アドレスはすでに使用されています)」エラーを減らすのに役立ちます。

true

 

Send TCP With No Delay (遅延なく TCP を送信)

Boolean (ブール)

設定すると、大幅に効率を向上するために、送信されるデータはまとめて収集されず、直ちに送信されます。今日では、遅延に比べてネットワークトラフィック量を削減する最適化が重要であることはめったにないので、ソケットのデフォルトが false であっても、デフォルトで true に設定されます。

true

 

Linger (リンガー)

Number (数値)

SO_LINGER 値を設定します。残りのデータが正常に送信されるようソケットが閉じるまでにかかる時間 (ミリ秒) に関連します。

 

Keep Alive (キープアライブ)

Boolean (ブール)

開いているソケットで SO_KEEPALIVE 動作を有効にします。接続が使用できなくなった場合、開いているけれども長時間使用されていないソケット接続を自動的にチェックして閉じます。これはソケット自体のプロパティで、サーバソケットによって使用されます。サーバとの接続がリサイクルされるまでキープアライブ状態にするかどうかを制御します。

false

 

Fail On Unresolved Host (ホストが未解決になると失敗)

Boolean (ブール)

エンドポイントに設定されたホストが解決できない場合、ソケットの作成中に失敗になるかどうか。ただし、未解決のホストを許可する場合は false に設定できます (プロキシを介して接続する場合に有用)。

true

 

Server Timeout (サーバタイムアウト)

Number (数値)

ソケットがサーバとして使用される場合の SO_TIMEOUT 値を設定します。これは "accept" 操作に適用されるタイムアウトです。0 (ServerSocket デフォルト値) にすると、無期限に accept を待機します (接続が受信されない場合)。

 

Receive Backlog (受信バックログ)

Number (数値)

受信接続のキューの最大長

50

 

UDP リスナ

SocketListener によって使用される UdpListenerConnection のインスタンスを提供する ConnectionProvider。

パラメータ
名前 説明 デフォルト値 必須

Port (ポート)

Number (数値)

接続のポート番号

x 

Host (ホスト)

String (文字列)

接続のホスト名

x 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

Disable Validation (検証の無効化)

Boolean (ブール)

接続の検証を無効にします。

 

Send Buffer Size (送信バッファサイズ)

Number (数値)

データの送信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Receive Buffer Size (受信バッファサイズ)

Number (数値)

データの受信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Client Timeout (クライアントタイムアウト)

Number (数値)

ソケットに SO_TIMEOUT 値を設定します。blocking 操作で失敗する前にソケットが待機する時間 (ミリ秒) を示します。0 (デフォルト値) は無期限に待機することを意味します。

 

Reuse Address (アドレスの再利用)

Boolean (ブール)

設定すると (デフォルト)、バインドする前にソケットに SO_REUSEADDRESS が設定されます。ソケットを再利用するときに発生する「address already in use (アドレスはすでに使用されています)」エラーを減らすのに役立ちます。

true

 

Broadcast (ブロードキャスト)

Boolean (ブール)

DatagramSocket への SO_BROADCAST を有効/無効にします。

false

 

関連付けられたソース


要求設定

リクエスタソケットへの AbstractSocketConfig の実装。

パラメータ

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。この名前は後から参照できます。

x 

Connection (接続)

この設定に指定できる接続型。

x 

Default Encoding (デフォルトのエンコード)

String (文字列)

文字列のシリアル化に使用されるデフォルトのエンコード。SocketOperations#send(RequesterConnection, RequesterConfig, Object, String, String, Message) 操作で String 型をシリアル化するとき、エンコードのパラメータが指定されていない場合は、このエンコードが使用されます。 また、SocketWorker でも SocketListener ソースによって送信される返信をエンコードするのにも使用されます。

 

接続種別

TCP リクエスタ

SocketOperations によって使用される TcpRequesterConnection のインスタンスを提供する ConnectionProvider。

パラメータ
名前 説明 デフォルト値 必須

Local Address Settings (ローカルアドレス設定)

この設定パラメータは Socket がバインドされるアドレスを参照します。

 

Protocol (プロトコル)

データがどのように読み書きされるのかを認識している TcpProtocol。指定しない場合、SafeProtocol が使用されます。

 

TLS Configuration (TLS 設定)

TLS

このパラメータがある場合、SSL 経由で接続を確立するために、単純な TCP ソケットの代わりに SSLSocket が使用されることを暗黙に示しています。

 

Port (ポート)

Number (数値)

接続のポート番号

x 

Host (ホスト)

String (文字列)

接続のホスト名

x 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

Disable Validation (検証の無効化)

Boolean (ブール)

接続の検証を無効にします。

 

Pooling Profile (プーリングプロファイル)

接続プールの特性。

 

Send Buffer Size (送信バッファサイズ)

Number (数値)

データの送信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Receive Buffer Size (受信バッファサイズ)

Number (数値)

データの受信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Client Timeout (クライアントタイムアウト)

Number (数値)

ソケットに SO_TIMEOUT 値を設定します。blocking 操作で失敗する前にソケットが待機する時間 (ミリ秒) を示します。0 (デフォルト値) は無期限に待機することを意味します。

 

Reuse Address (アドレスの再利用)

Boolean (ブール)

設定すると (デフォルト)、バインドする前にソケットに SO_REUSEADDRESS が設定されます。ソケットを再利用するときに発生する「address already in use (アドレスはすでに使用されています)」エラーを減らすのに役立ちます。

true

 

Send TCP With No Delay (遅延なく TCP を送信)

Boolean (ブール)

設定すると、大幅に効率を向上するために、送信されるデータはまとめて収集されず、直ちに送信されます。今日では、遅延に比べてネットワークトラフィック量を削減する最適化が重要であることはめったにないので、ソケットのデフォルトが false であっても、デフォルトで true に設定されます。

true

 

Linger (リンガー)

Number (数値)

SO_LINGER 値を設定します。残りのデータが正常に送信されるようソケットが閉じるまでにかかる時間 (ミリ秒) に関連します。

 

Keep Alive (キープアライブ)

Boolean (ブール)

開いているソケットで SO_KEEPALIVE 動作を有効にします。接続が使用できなくなった場合、開いているけれども長時間使用されていないソケット接続を自動的にチェックして閉じます。これはソケット自体のプロパティで、サーバソケットによって使用されます。サーバとの接続がリサイクルされるまでキープアライブ状態にするかどうかを制御します。

false

 

Fail On Unresolved Host (ホストが未解決になると失敗)

Boolean (ブール)

エンドポイントに設定されたホストが解決できない場合、ソケットの作成中に失敗になるかどうか。ただし、未解決のホストを許可する場合は false に設定できます (プロキシを介して接続する場合に有用)。

true

 

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサーバへの送信接続が正常に作成されるまで待機するミリ秒数。デフォルトでは 30 秒に設定されます。

30000

 

UDP リクエスタ

SocketOperations によって使用される UdpRequesterConnection のインスタンスを提供する ConnectionProvider。

パラメータ
名前 説明 デフォルト値 必須

Local Address Settings (ローカルアドレス設定)

この設定パラメータは DatagramSocket がバインドされるアドレスを参照します。

 

Port (ポート)

Number (数値)

接続のポート番号

x 

Host (ホスト)

String (文字列)

接続のホスト名

x 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

Disable Validation (検証の無効化)

Boolean (ブール)

接続の検証を無効にします。

 

Pooling Profile (プーリングプロファイル)

接続プールの特性。

 

Send Buffer Size (送信バッファサイズ)

Number (数値)

データの送信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Receive Buffer Size (受信バッファサイズ)

Number (数値)

データの受信時に使用されるバッファのサイズ (バイト単位)。ソケット自体に設定されます。

 

Client Timeout (クライアントタイムアウト)

Number (数値)

ソケットに SO_TIMEOUT 値を設定します。blocking 操作で失敗する前にソケットが待機する時間 (ミリ秒) を示します。0 (デフォルト値) は無期限に待機することを意味します。

 

Reuse Address (アドレスの再利用)

Boolean (ブール)

設定すると (デフォルト)、バインドする前にソケットに SO_REUSEADDRESS が設定されます。ソケットを再利用するときに発生する「address already in use (アドレスはすでに使用されています)」エラーを減らすのに役立ちます。

true

 

Broadcast (ブロードキャスト)

Boolean (ブール)

DatagramSocket への SO_BROADCAST を有効/無効にします。

false

 

関連操作

操作

Send

<http://www.mulesoft.org/schema/mule/sockets:send>

RequesterConnection に関連付けられているクライアントを使用してデータを送信します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Content (コンテンツ)

Any (任意)

シリアル化されてソケットを介して送信されるデータ。

#[payload]

 

Output Encoding (出力エンコード)

String (文字列)

データが String 型の場合、シリアル化に使用されるエンコード。

 

次の設定の場合

スロー

  • SOCKETS:RETRY_EXHAUSTED  

  • SOCKETS:CONNECTIVITY  

Send And Receive

<http://www.mulesoft.org/schema/mule/sockets:send-and-receive>

RequesterConnection に関連付けられているクライアントを使用してデータを送信した後、応答を受信するまで、またはタイムアウトになるまで (この場合、null ペイロードが返される) ブロックします。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Content (コンテンツ)

Any (任意)

シリアル化されてソケットを介して送信されるデータ。

#[payload]

 

Output Encoding (出力エンコード)

String (文字列)

データが String 型の場合、シリアル化に使用されるエンコード。

 

Streaming Strategy (ストリーミング戦略)

繰り返し可能なストリームを使用するかどうかと、それらの動作を設定します。

 

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

 

出力

Binary (バイナリ)

属性型

SocketAttributes

次の設定の場合

スロー

  • SOCKETS:RETRY_EXHAUSTED  

  • SOCKETS:CONNECTIVITY  

Sources (ソース)

ソケットリスナ

<http://www.mulesoft.org/schema/mule/sockets:socket-listener>

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

 

Streaming Strategy (ストリーミング戦略)

繰り返し可能なストリームを使用するかどうかと、それらの動作を設定します。

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

Response Value (応答値)

Any (任意)

#[mel:payload]

 

出力

Binary (バイナリ)

属性型

SocketAttributes

次の設定の場合

スロー

  • MULE:SOURCE_RESPONSE_SEND  

  • MULE:SOURCE_ERROR_RESPONSE_SEND  

  • MULE:SOURCE_ERROR_RESPONSE_GENERATE  

  • MULE:SOURCE_RESPONSE_GENERATE  

TLS

項目 デフォルト値

Enabled Protocols (有効化されたプロトコル)

String (文字列)

Enabled Cipher Suites (有効化された暗号スイート)

String (文字列)

Trust Store (トラストストア)

Key Store (キーストア)

Trust Store (信頼ストア)

項目 デフォルト値

Path (パス)

String (文字列)

Password (パスワード)

String (文字列)

Type (種類)

  • Enumeration (列挙)。次のいずれかになります。

    • jks

    • jceks

    • pkcs12

  • String (文字列)

Algorithm (アルゴリズム)

String (文字列)

Insecure (安全ではない)

Boolean (ブール)

Key Store (キーストア)

項目 デフォルト値

Path (パス)

String (文字列)

Type (種類)

  • Enumeration (列挙)。次のいずれかになります。

    • jks

    • jceks

    • pkcs12

  • String (文字列)

Alias (エイリアス)

String (文字列)

Key Password (キーパスワード)

String (文字列)

Password (パスワード)

String (文字列)

Algorithm (アルゴリズム)

String (文字列)

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

Count (カウント)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Redelivery Policy (再配信ポリシー)

項目 デフォルト値

Max Redelivery Count (最大再配信数)

Number (数値)

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

Id Expression (ID 式)

String (文字列)

Object Store Ref (オブジェクトストア参照)

String (文字列)

Repeatable In Memory Stream (繰り返し可能なメモリ内ストリーム)

項目 デフォルト値

Initial Buffer Size (初期バッファサイズ)

Number (数値)

Buffer Size Increment (バッファサイズ増分)

Number (数値)

Max Buffer Size (最大バッファサイズ)

Number (数値)

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれか:

  • BYTE (バイト)

  • KB (キロバイト)

  • MB (メガバイト)

  • GB (ギガバイト)

Repeatable File Store Stream (繰り返し可能なファイルストアストリーム)

項目 デフォルト値

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれか:

  • BYTE (バイト)

  • KB (キロバイト)

  • MB (メガバイト)

  • GB (ギガバイト)

Socket Connection Settings (ソケットコネクション設定)

項目 デフォルト値

Port (ポート)

Number (数値)

Host (ホスト)

String (文字列)

Pooling Profile (プーリングプロファイル)

項目 デフォルト値

Max Active (最大アクティブ時間)

Number (数値)

Max Idle (最大アイドル時間)

Number (数値)

Max Wait (最大待機時間)

Number (数値)

Min Eviction Millis (最小除去時間)

Number (数値)

Eviction Check Interval Millis (除去確認間隔)

Number (数値)

Exhausted Action (枯渇アクション)

次のいずれかの Enumeration (列挙)

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Initialisation Policy (初期化ポリシー)

次のいずれかの Enumeration (列挙)

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Disabled (無効)

Boolean (ブール)

Safe Protocol (安全なプロトコル)

項目 デフォルト値

Max Message Leght (最大メッセージ長)

Number (数値)

-1

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

Direct Protocol (ダイレクトプロトコル)

項目 デフォルト値

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

Length Protocol (長さのプロトコル)

項目 デフォルト値

Max Message Length (最大メッセージ長)

Number (数値)

-1

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

Streaming Protocol (ストリーミングプロトコル)

項目 デフォルト値

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

XML Message Protocol (XML メッセージプロトコル)

項目 デフォルト値

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

XML Message Eof Protocol (XML メッセージ Eof プロトコル)

項目 デフォルト値

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

Custom Protocol (カスタムプロトコル)

項目 デフォルト値

Class (クラス)

String (文字列)

EOF Protocol (EOF プロトコル)

項目 デフォルト値

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

Custom Class Loading Length Protocol (カスタムクラス読み込み長のプロトコル)

項目 デフォルト値

Class Loader (クラスローダー)

Any (任意)

Max Message Length (最大メッセージ長)

Number (数値)

-1

Rethrow Exception On Read (読み取り時に例外を再スロー)

Boolean (ブール)

false

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub