クラス TcpConnectionSupport
java.lang.ObjectSE
org.springframework.integration.ip.tcp.connection.TcpConnectionSupport
- 実装済みのインターフェース一覧:
RunnableSE, TcpConnection
TcpConnections の基本クラス。TcpConnections は、クライアント接続ファクトリ(送信)またはサーバー接続ファクトリ(受信)によって確立されます。
- 導入:
- 2.0
- 作成者:
- Gary Russell, Artem Bilan, Ngoc Nhan
フィールド概要
フィールドコンストラクター概要
コンストラクターコンストラクター説明TcpConnectionSupport(SocketSE socket, boolean server, boolean lookupHost, @Nullable ApplicationEventPublisher applicationEventPublisher, @Nullable StringSE connectionFactoryName) イベント発行者が提供されている場合は、TcpConnectionSupportオブジェクトを作成し、TcpConnectionOpenEventを発行します。TcpConnectionSupport(@Nullable ApplicationEventPublisher applicationEventPublisher) 方法の概要
修飾子と型メソッド説明voidclose()この接続を閉じます。protected voidcloseConnection(boolean isException) インターセプトされている場合は、最も外側のインターセプターからクローズを伝搬します。それ以外の場合は、close() を呼び出します。voidTcpListenerの自動登録を使用するか、手動登録を使用するかを設定します。Deserializer<?> @Nullable TcpListener@Nullable TcpSender送信者のリストを返します。Serializer<?> @Nullable SocketInfoSocketSE プロパティに getter を提供します。longprotected booleanbooleanisServer()protected voidprotected voidprotected voidvoidpublishEvent(TcpConnectionEvent event) インターセプターなどがイベント、おそらく TcpConnectionEvent のサブクラスを発行できるようにします。voidregisterListener(@Nullable TcpListener listener) 受信メッセージを受信するリスナーを設定します。voidregisterSender(@Nullable TcpSender senderToRegister) 送信者を登録します。voidregisterSenders(ListSE<TcpSender> sendersToRegister) 送信者を登録します。voidregisterTestListener(TcpListener tListener) 最初の受信メッセージのみを受信するように一時リスナーを設定します。protected final voidvoidsetDeserializer(Deserializer<?> deserializer) voidsetMapper(TcpMessageMapper mapper) voidsetNeedsTest(boolean needsTest) 最初の受信メッセージのみに一時リスナーを使用するには、true に設定します。protected voidsetNoReadErrorOnClose(boolean noReadErrorOnClose) voidsetSerializer(Serializer<?> serializer) voidsetWrapped(boolean wrapped) インターセプトされた場合は true に設定します。voidsetWrapper(TcpConnectionSupport wrapper) ラッパーを設定します。toString()クラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSEインターフェース RunnableSE から継承されたメソッド
runインターフェース TcpConnection から継承されたメソッド
getDeserializerStateKey, getPayload, getPort, getSslSession, isOpen, send, shutdownInput, shutdownOutput
フィールドの詳細
logger
protected final org.apache.commons.logging.Log logger
コンストラクターの詳細
TcpConnectionSupport
public TcpConnectionSupport()TcpConnectionSupport
TcpConnectionSupport
public TcpConnectionSupport(SocketSE socket, boolean server, boolean lookupHost, @Nullable ApplicationEventPublisher applicationEventPublisher, @Nullable StringSE connectionFactoryName) イベント発行者が提供されている場合は、TcpConnectionSupportオブジェクトを作成し、TcpConnectionOpenEventを発行します。- パラメーター:
socket- 基本となるソケット。server- この接続がサーバー接続の場合は truelookupHost- ホスト名の逆ルックアップを実行する必要がある場合は true、それ以外の場合は、識別のために IP アドレスが使用されます。applicationEventPublisher- オープン、クローズ、例外イベントが送信されるパブリッシャー。イベントの公開が不要な場合は null になることがあります。connectionFactoryName- この接続を作成する接続ファクトリの名前。イベントの発行中に使用され、null の場合があります。その場合、「不明」が使用されます。
方法の詳細
close
closeConnection
protected void closeConnection(boolean isException) インターセプトされている場合は、最も外側のインターセプターからクローズを伝搬します。それ以外の場合は、close() を呼び出します。- パラメーター:
isException- この呼び出しが例外の結果である場合は true。
getMapper
- 戻り値:
- マッパー
setMapper
- パラメーター:
mapper- 設定するマッパー
getDeserializer
- 次で指定:
- インターフェース
TcpConnection内のgetDeserializer - 戻り値:
- デシリアライザー
setDeserializer
- パラメーター:
deserializer- 設定するデシリアライザー
getSerializer
- 次で指定:
- インターフェース
TcpConnection内のgetSerializer - 戻り値:
- シリアライザー
setSerializer
- パラメーター:
serializer- 設定するシリアライザー
setNeedsTest
public void setNeedsTest(boolean needsTest) 最初の受信メッセージのみに一時リスナーを使用するには、true に設定します。- パラメーター:
needsTest- 一時リスナーの場合は true。- 導入:
- 5.3
registerListener
受信メッセージを受信するリスナーを設定します。- パラメーター:
listener- リスナー。
registerTestListener
最初の受信メッセージのみを受信するように一時リスナーを設定します。クライアント接続ファクトリの connectionTest と組み合わせて使用します。- パラメーター:
tListener- テストリスナー。- 導入:
- 5.3
enableManualListenerRegistration
public void enableManualListenerRegistration()TcpListenerの自動登録と手動登録のどちらを使用するかを設定します。(デフォルトは自動)。手動登録を選択した場合、リスナーが登録されるまで受信メッセージは遅延されます。- 導入:
- 1.4.5
registerSender
送信者を登録します。送信者が応答を送信する接続を決定できるように、サーバー側の接続で使用されます。- パラメーター:
senderToRegister- 送り主。
registerSenders
getListener
- 次で指定:
- インターフェース
TcpConnection内のgetListener - 戻り値:
- リスナー
getSender
- 戻り値:
- 存在する場合、最初の送信者。
getSenders
isServer
public boolean isServer()- 次で指定:
- インターフェース
TcpConnection内のisServer - 戻り値:
- 接続が 1 回使用される場合は true。
incrementAndGetConnectionSequence
public long incrementAndGetConnectionSequence()- 次で指定:
- インターフェース
TcpConnection内のincrementAndGetConnectionSequence - 戻り値:
- このソケットで受信したメッセージの次のシーケンス番号
getHostAddress
- 次で指定:
- インターフェース
TcpConnection内のgetHostAddress - 戻り値:
- ホストアドレス
getHostName
- 次で指定:
- インターフェース
TcpConnection内のgetHostName - 戻り値:
- ホスト名
getConnectionId
- 次で指定:
- インターフェース
TcpConnection内のgetConnectionId - 戻り値:
- 接続を一意に表す文字列。
getSocketInfo
インターフェースからコピーされた説明:TcpConnectionSocketSE プロパティに getter を提供します。- 次で指定:
- インターフェース
TcpConnection内のgetSocketInfo - 戻り値:
- socketInfo - たとえばインターセプターでは null になる場合があります。インターセプターはオーバーライドして実際の TcpConnection に委譲する必要があります。
- 導入:
- 4.2.5
setWrapped
public void setWrapped(boolean wrapped) インターセプトされた場合は true に設定します。- パラメーター:
wrapped- ラップされている場合は true。- 導入:
- 5.4.5
setWrapper
getConnectionFactoryName
isNoReadErrorOnClose
protected boolean isNoReadErrorOnClose()setNoReadErrorOnClose
protected void setNoReadErrorOnClose(boolean noReadErrorOnClose) sendExceptionToListener
publishConnectionOpenEvent
protected void publishConnectionOpenEvent()publishConnectionCloseEvent
protected void publishConnectionCloseEvent()publishConnectionExceptionEvent
publishEvent
インターセプターなどがイベント、おそらく TcpConnectionEvent のサブクラスを発行できるようにします。イベントソースはこの接続である必要があります。- パラメーター:
event- 公開するイベント。
toString