クラス AbstractWebSocketSession<T>
java.lang.ObjectSE
org.springframework.web.socket.adapter.AbstractWebSocketSession<T>
- 型パラメーター:
T- ネイティブセッション型
- 実装されているすべてのインターフェース:
CloseableSE, AutoCloseableSE, NativeWebSocketSession, WebSocketSession
- 既知の直属サブクラス
JettyWebSocketSession, StandardWebSocketSession
public abstract class AbstractWebSocketSession<T>
extends ObjectSE
implements NativeWebSocketSession
WebSocketSession の実装の抽象基本クラス。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
フィールドのサマリー
フィールド修飾子と型フィールド説明protected static final IdGeneratorprotected static final org.apache.commons.logging.Logコンストラクターの概要
コンストラクターコンストラクター説明AbstractWebSocketSession(@Nullable MapSE<StringSE, ObjectSE> attributes) 新しいインスタンスを作成し、指定された属性をそれに関連付けます。メソッドのサマリー
修飾子と型メソッド説明protected final voidfinal voidclose()ステータス 1000 で WebSocket 接続を閉じます。final voidclose(CloseStatus status) 指定されたクローズ状態で WebSocket 接続を閉じます。protected abstract voidcloseInternal(CloseStatus status) WebSocket セッションに関連付けられた属性を持つマップを返します。基礎となるネイティブ WebSocketSession を返します。<R> @Nullable RgetNativeSession(@Nullable ClassSE<R> requiredType) 使用可能な場合、基礎となるネイティブ WebSocketSession を返します。voidinitializeNativeSession(T session) protected abstract voidsendBinaryMessage(BinaryMessage message) final voidsendMessage(WebSocketMessage<?> message) WebSocket メッセージを送信する:TextMessageまたはBinaryMessageのいずれか。protected abstract voidsendPingMessage(PingMessage message) protected abstract voidsendPongMessage(PongMessage message) protected abstract voidsendTextMessage(TextMessage message) toString()
フィールドの詳細
idGenerator
logger
protected static final org.apache.commons.logging.Log logger
コンストラクターの詳細
AbstractWebSocketSession
メソッドの詳細
getAttributes
インターフェースからコピーされた説明:WebSocketSessionWebSocket セッションに関連付けられた属性を持つマップを返します。サーバー側では、最初に
HandshakeInterceptorを介してマップにデータを入力できます。クライアント側では、WebSocketClientハンドシェイクメソッドを介してマップにデータを入力できます。- 次で指定:
- インターフェース
WebSocketSessionのgetAttributes - 戻り値:
- セッション属性を持つマップ (非
null)
getNativeSession
インターフェースからコピーされた説明:NativeWebSocketSession基礎となるネイティブ WebSocketSession を返します。- 次で指定:
- インターフェース
NativeWebSocketSessionのgetNativeSession
getNativeSession
インターフェースからコピーされた説明:NativeWebSocketSession使用可能な場合、基礎となるネイティブ WebSocketSession を返します。- 次で指定:
- インターフェース
NativeWebSocketSessionのgetNativeSession - パラメーター:
requiredType- 必要なセッションの型- 戻り値:
- 必要な型のネイティブセッション、または利用できない場合は
null
initializeNativeSession
checkNativeSessionInitialized
protected final void checkNativeSessionInitialized()sendMessage
インターフェースからコピーされた説明:WebSocketSessionWebSocket メッセージを送信する:TextMessageまたはBinaryMessageのいずれか。注意 : 基盤となる標準の WebSocket セッション(JSR-356)では、同時送信は許可されていません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、
WebSocketSessionをConcurrentWebSocketSessionDecoratorでラップすることです。- 次で指定:
- インターフェース
WebSocketSessionのsendMessage - 例外:
IOExceptionSE- 関連事項:
sendTextMessage
sendBinaryMessage
sendPingMessage
sendPongMessage
close
インターフェースからコピーされた説明:WebSocketSessionWebSocket 接続をステータス 1000 で閉じます。session.close(CloseStatus.NORMAL);
- 次で指定:
- インターフェース
AutoCloseableSEのclose - 次で指定:
- インターフェース
CloseableSEのclose - 次で指定:
- インターフェース
WebSocketSessionのclose - 例外:
IOExceptionSE
close
インターフェースからコピーされた説明:WebSocketSession指定されたクローズ状態で WebSocket 接続を閉じます。- 次で指定:
- インターフェース
WebSocketSessionのclose - 例外:
IOExceptionSE
closeInternal
toString