クラス AbstractClientSockJsSession
java.lang.ObjectSE
org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
- 実装されたすべてのインターフェース:
CloseableSE
、AutoCloseableSE
、WebSocketSession
- 既知の直属サブクラス
WebSocketClientSockJsSession
,XhrClientSockJsSession
WebSocketSession
の SockJS クライアント実装の基本クラス。 受信 SockJS メッセージフレームの処理を提供し、ライフサイクルイベントとメッセージを (アプリケーション) WebSocketHandler
に委譲します。
サブクラスは、実際の送信ロジックと切断ロジックを実装します。
- 導入:
- 4.1
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller
フィールドサマリー
フィールドコンストラクターのサマリー
コンストラクター修飾子コンストラクター説明protected
AbstractClientSockJsSession
(TransportRequest request, WebSocketHandler handler, CompletableFutureSE<WebSocketSession> connectFuture) protected
AbstractClientSockJsSession
(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。メソッドのサマリー
修飾子と型メソッド説明void
afterTransportClosed
(CloseStatus closeStatus) final void
close()
ステータス 1000 で WebSocket 接続を閉じます。final void
close
(CloseStatus status) 指定されたクローズ状態で WebSocket 接続を閉じます。protected void
closeInternal
(CloseStatus status) protected abstract void
disconnect
(CloseStatus status) WebSocket セッションに関連付けられた属性を持つマップを返します。ハンドシェイクリクエストで使用されるヘッダーを返します(非null
)。getId()
一意のセッション識別子を返します。認証されたユーザーの名前を含むPrincipal
SE インスタンスを返します。getUri()
WebSocket 接続を開くために使用される URI を返します。void
handleFrame
(StringSE payload) void
handleTransportError
(ThrowableSE error) boolean
boolean
isOpen()
基になる接続が開いているかどうか。protected abstract void
sendInternal
(TextMessage textMessage) final void
sendMessage
(WebSocketMessage<?> message) WebSocket メッセージを送信する:TextMessage
またはBinaryMessage
のいずれか。toString()
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド
getAcceptedProtocol, getBinaryMessageSizeLimit, getExtensions, getLocalAddress, getRemoteAddress, getTextMessageSizeLimit, setBinaryMessageSizeLimit, setTextMessageSizeLimit
フィールドの詳細
logger
コンストラクターの詳細
AbstractClientSockJsSession
@DeprecatedSE(since="6.0") protected AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。新しいAbstractClientSockJsSession
を作成します。AbstractClientSockJsSession
protected AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, CompletableFutureSE<WebSocketSession> connectFuture)
メソッドの詳細
getId
インターフェースからコピーされた説明:WebSocketSession
一意のセッション識別子を返します。- 次で指定:
- インターフェース
WebSocketSession
のgetId
getUri
インターフェースからコピーされた説明:WebSocketSession
WebSocket 接続を開くために使用される URI を返します。- 次で指定:
- インターフェース
WebSocketSession
のgetUri
getHandshakeHeaders
インターフェースからコピーされた説明:WebSocketSession
ハンドシェイクリクエストで使用されるヘッダーを返します(非null
)。- 次で指定:
- インターフェース
WebSocketSession
のgetHandshakeHeaders
getAttributes
インターフェースからコピーされた説明:WebSocketSession
WebSocket セッションに関連付けられた属性を持つマップを返します。サーバー側では、最初に
HandshakeInterceptor
を介してマップにデータを入力できます。クライアント側では、WebSocketClient
ハンドシェイクメソッドを介してマップにデータを入力できます。- 次で指定:
- インターフェース
WebSocketSession
のgetAttributes
- 戻り値:
- セッション属性を持つマップ (非
null
)
getPrincipal
インターフェースからコピーされた説明:WebSocketSession
認証されたユーザーの名前を含むPrincipal
SE インスタンスを返します。ユーザーが認証されていない場合、メソッドは
null
を返します。- 次で指定:
- インターフェース
WebSocketSession
のgetPrincipal
getMessageCodec
getWebSocketHandler
isOpen
public boolean isOpen()インターフェースからコピーされた説明:WebSocketSession
基になる接続が開いているかどうか。- 次で指定:
- インターフェース
WebSocketSession
のisOpen
isDisconnected
public boolean isDisconnected()sendMessage
インターフェースからコピーされた説明:WebSocketSession
WebSocket メッセージを送信する:TextMessage
またはBinaryMessage
のいずれか。注意 : 基盤となる標準の WebSocket セッション(JSR-356)では、同時送信は許可されていません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、
WebSocketSession
をConcurrentWebSocketSessionDecorator
でラップすることです。- 次で指定:
- インターフェース
WebSocketSession
のsendMessage
- 例外:
IOExceptionSE
- 関連事項:
sendInternal
close
インターフェースからコピーされた説明:WebSocketSession
WebSocket 接続をステータス 1000 で閉じます。session.close(CloseStatus.NORMAL);
- 次で指定:
- インターフェース
AutoCloseableSE
のclose
- 次で指定:
- インターフェース
CloseableSE
のclose
- 次で指定:
- インターフェース
WebSocketSession
のclose
- 例外:
IOExceptionSE
close
インターフェースからコピーされた説明:WebSocketSession
指定されたクローズ状態で WebSocket 接続を閉じます。- 次で指定:
- インターフェース
WebSocketSession
のclose
- 例外:
IOExceptionSE
closeInternal
disconnect
handleFrame
handleTransportError
afterTransportClosed
toString
AbstractClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture)
を推奨