クラス 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
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクター修飾子コンストラクター説明protectedAbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, CompletableFutureSE<WebSocketSession> connectFuture) protectedAbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。メソッドのサマリー
修飾子と型メソッド説明voidafterTransportClosed(CloseStatus closeStatus) final voidclose()ステータス 1000 で WebSocket 接続を閉じます。final voidclose(CloseStatus status) 指定されたクローズ状態で WebSocket 接続を閉じます。protected voidcloseInternal(CloseStatus status) protected abstract voiddisconnect(CloseStatus status) WebSocket セッションに関連付けられた属性を持つマップを返します。ハンドシェイクリクエストで使用されるヘッダーを返します(非null)。getId()一意のセッション識別子を返します。認証されたユーザーの名前を含むPrincipalSE インスタンスを返します。getUri()WebSocket 接続を開くために使用される URI を返します。voidhandleFrame(StringSE payload) voidhandleTransportError(ThrowableSE error) booleanbooleanisOpen()基になる接続が開いているかどうか。protected abstract voidsendInternal(TextMessage textMessage) final voidsendMessage(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
インターフェースからコピーされた説明:WebSocketSessionWebSocket 接続を開くために使用される URI を返します。- 次で指定:
- インターフェース
WebSocketSessionのgetUri
getHandshakeHeaders
インターフェースからコピーされた説明:WebSocketSessionハンドシェイクリクエストで使用されるヘッダーを返します(非null)。- 次で指定:
- インターフェース
WebSocketSessionのgetHandshakeHeaders
getAttributes
インターフェースからコピーされた説明:WebSocketSessionWebSocket セッションに関連付けられた属性を持つマップを返します。サーバー側では、最初に
HandshakeInterceptorを介してマップにデータを入力できます。クライアント側では、WebSocketClientハンドシェイクメソッドを介してマップにデータを入力できます。- 次で指定:
- インターフェース
WebSocketSessionのgetAttributes - 戻り値:
- セッション属性を持つマップ (非
null)
getPrincipal
インターフェースからコピーされた説明:WebSocketSession認証されたユーザーの名前を含むPrincipalSE インスタンスを返します。ユーザーが認証されていない場合、メソッドは
nullを返します。- 次で指定:
- インターフェース
WebSocketSessionのgetPrincipal
getMessageCodec
getWebSocketHandler
isOpen
public boolean isOpen()インターフェースからコピーされた説明:WebSocketSession基になる接続が開いているかどうか。- 次で指定:
- インターフェース
WebSocketSessionのisOpen
isDisconnected
public boolean isDisconnected()sendMessage
インターフェースからコピーされた説明:WebSocketSessionWebSocket メッセージを送信する:TextMessageまたはBinaryMessageのいずれか。注意 : 基盤となる標準の WebSocket セッション(JSR-356)では、同時送信は許可されていません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、
WebSocketSessionをConcurrentWebSocketSessionDecoratorでラップすることです。- 次で指定:
- インターフェース
WebSocketSessionのsendMessage - 例外:
IOExceptionSE- 関連事項:
sendInternal
close
インターフェースからコピーされた説明:WebSocketSessionWebSocket 接続をステータス 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)を推奨