クラス 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
フィールドサマリー
コンストラクターのサマリー
コンストラクター説明AbstractWebSocketSession
(MapSE<StringSE, ObjectSE> attributes) 新しいインスタンスを作成し、指定された属性をそれに関連付けます。メソッドのサマリー
修飾子と型メソッド説明protected final void
final void
close()
ステータス 1000 で WebSocket 接続を閉じます。final void
close
(CloseStatus status) 指定されたクローズ状態で WebSocket 接続を閉じます。protected abstract void
closeInternal
(CloseStatus status) WebSocket セッションに関連付けられた属性を持つマップを返します。基礎となるネイティブ WebSocketSession を返します。<R> R
getNativeSession
(ClassSE<R> requiredType) 使用可能な場合、基礎となるネイティブ WebSocketSession を返します。void
initializeNativeSession
(T session) protected abstract void
sendBinaryMessage
(BinaryMessage message) final void
sendMessage
(WebSocketMessage<?> message) WebSocket メッセージを送信する:TextMessage
またはBinaryMessage
のいずれか。protected abstract void
sendPingMessage
(PingMessage message) protected abstract void
sendPongMessage
(PongMessage message) protected abstract void
sendTextMessage
(TextMessage message) toString()
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド
getAcceptedProtocol, getBinaryMessageSizeLimit, getExtensions, getHandshakeHeaders, getId, getLocalAddress, getPrincipal, getRemoteAddress, getTextMessageSizeLimit, getUri, isOpen, setBinaryMessageSizeLimit, setTextMessageSizeLimit
フィールドの詳細
idGenerator
logger
コンストラクターの詳細
AbstractWebSocketSession
新しいインスタンスを作成し、指定された属性をそれに関連付けます。- パラメーター:
attributes
- WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。提供された属性がコピーされ、元のマップは使用されません。
メソッドの詳細
getAttributes
インターフェースからコピーされた説明:WebSocketSession
WebSocket セッションに関連付けられた属性を持つマップを返します。サーバー側では、最初に
HandshakeInterceptor
を介してマップにデータを入力できます。クライアント側では、WebSocketClient
ハンドシェイクメソッドを介してマップにデータを入力できます。- 次で指定:
- インターフェース
WebSocketSession
のgetAttributes
- 戻り値:
- セッション属性を持つマップ (非
null
)
getNativeSession
インターフェースからコピーされた説明:NativeWebSocketSession
基礎となるネイティブ WebSocketSession を返します。- 次で指定:
- インターフェース
NativeWebSocketSession
のgetNativeSession
getNativeSession
インターフェースからコピーされた説明:NativeWebSocketSession
使用可能な場合、基礎となるネイティブ WebSocketSession を返します。- 次で指定:
- インターフェース
NativeWebSocketSession
のgetNativeSession
- パラメーター:
requiredType
- 必要なセッションの型- 戻り値:
- 必要な型のネイティブセッション、または利用できない場合は
null
initializeNativeSession
checkNativeSessionInitialized
protected final void checkNativeSessionInitialized()sendMessage
インターフェースからコピーされた説明:WebSocketSession
WebSocket メッセージを送信する:TextMessage
またはBinaryMessage
のいずれか。注意 : 基盤となる標準の WebSocket セッション(JSR-356)では、同時送信は許可されていません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、
WebSocketSession
をConcurrentWebSocketSessionDecorator
でラップすることです。- 次で指定:
- インターフェース
WebSocketSession
のsendMessage
- 例外:
IOExceptionSE
- 関連事項:
sendTextMessage
sendBinaryMessage
sendPingMessage
sendPongMessage
close
インターフェースからコピーされた説明:WebSocketSession
WebSocket 接続をステータス 1000 で閉じます。session.close(CloseStatus.NORMAL);
- 次で指定:
- インターフェース
AutoCloseableSE
のclose
- 次で指定:
- インターフェース
CloseableSE
のclose
- 次で指定:
- インターフェース
WebSocketSession
のclose
- 例外:
IOExceptionSE
close
インターフェースからコピーされた説明:WebSocketSession
指定されたクローズ状態で WebSocket 接続を閉じます。- 次で指定:
- インターフェース
WebSocketSession
のclose
- 例外:
IOExceptionSE
closeInternal
toString