クラス WebSocketSessionDecorator
java.lang.ObjectSE
org.springframework.web.socket.handler.WebSocketSessionDecorator
- 実装されたすべてのインターフェース:
CloseableSE
、AutoCloseableSE
、WebSocketSession
- 既知の直属サブクラス
ConcurrentWebSocketSessionDecorator
別の
WebSocketSession
インスタンスをラップし、それに委譲します。 また、装飾されたセッションを返す getDelegate()
メソッドと、すべてのネストされたデリゲートを通過して「最後の」セッションを返す getLastSession()
メソッドも提供します。
- 導入:
- 4.0.3
- 作成者:
- Rossen Stoyanchev
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
close()
ステータス 1000 で WebSocket 接続を閉じます。void
close
(CloseStatus status) 指定されたクローズ状態で WebSocket 接続を閉じます。ネゴシエートされたサブプロトコルを返します。WebSocket セッションに関連付けられた属性を持つマップを返します。int
受信バイナリメッセージの構成済みの最大サイズを取得します。ネゴシエートされた拡張機能を決定します。ハンドシェイクリクエストで使用されるヘッダーを返します(非null
)。getId()
一意のセッション識別子を返します。リクエストが受信されたアドレスを返します。認証されたユーザーの名前を含むPrincipal
SE インスタンスを返します。リモートクライアントのアドレスを返します。int
受信テキストメッセージの構成済みの最大サイズを取得します。getUri()
WebSocket 接続を開くために使用される URI を返します。boolean
isOpen()
基になる接続が開いているかどうか。void
sendMessage
(WebSocketMessage<?> message) WebSocket メッセージを送信する:TextMessage
またはBinaryMessage
のいずれか。void
setBinaryMessageSizeLimit
(int messageSizeLimit) 受信バイナリメッセージの最大サイズを構成します。void
setTextMessageSizeLimit
(int messageSizeLimit) 受信テキストメッセージの最大サイズを構成します。toString()
static WebSocketSession
unwrap
(WebSocketSession session)
コンストラクターの詳細
WebSocketSessionDecorator
メソッドの詳細
getDelegate
getLastSession
unwrap
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
getLocalAddress
インターフェースからコピーされた説明:WebSocketSession
リクエストが受信されたアドレスを返します。- 次で指定:
- インターフェース
WebSocketSession
のgetLocalAddress
getRemoteAddress
インターフェースからコピーされた説明:WebSocketSession
リモートクライアントのアドレスを返します。- 次で指定:
- インターフェース
WebSocketSession
のgetRemoteAddress
getAcceptedProtocol
インターフェースからコピーされた説明:WebSocketSession
ネゴシエートされたサブプロトコルを返します。- 次で指定:
- インターフェース
WebSocketSession
のgetAcceptedProtocol
- 戻り値:
- プロトコル識別子、またはプロトコルが指定されていないか正常にネゴシエートされた場合は
null
getExtensions
インターフェースからコピーされた説明:WebSocketSession
ネゴシエートされた拡張機能を決定します。- 次で指定:
- インターフェース
WebSocketSession
のgetExtensions
- 戻り値:
- 拡張機能のリスト、または拡張機能が指定されていないか正常にネゴシエートされていない場合は空のリスト
setTextMessageSizeLimit
public void setTextMessageSizeLimit(int messageSizeLimit) インターフェースからコピーされた説明:WebSocketSession
受信テキストメッセージの最大サイズを構成します。- 次で指定:
- インターフェース
WebSocketSession
のsetTextMessageSizeLimit
getTextMessageSizeLimit
public int getTextMessageSizeLimit()インターフェースからコピーされた説明:WebSocketSession
受信テキストメッセージの構成済みの最大サイズを取得します。- 次で指定:
- インターフェース
WebSocketSession
のgetTextMessageSizeLimit
setBinaryMessageSizeLimit
public void setBinaryMessageSizeLimit(int messageSizeLimit) インターフェースからコピーされた説明:WebSocketSession
受信バイナリメッセージの最大サイズを構成します。- 次で指定:
- インターフェース
WebSocketSession
のsetBinaryMessageSizeLimit
getBinaryMessageSizeLimit
public int getBinaryMessageSizeLimit()インターフェースからコピーされた説明:WebSocketSession
受信バイナリメッセージの構成済みの最大サイズを取得します。- 次で指定:
- インターフェース
WebSocketSession
のgetBinaryMessageSizeLimit
isOpen
public boolean isOpen()インターフェースからコピーされた説明:WebSocketSession
基になる接続が開いているかどうか。- 次で指定:
- インターフェース
WebSocketSession
のisOpen
sendMessage
インターフェースからコピーされた説明:WebSocketSession
WebSocket メッセージを送信する:TextMessage
またはBinaryMessage
のいずれか。注意 : 基盤となる標準の WebSocket セッション(JSR-356)では、同時送信は許可されていません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、
WebSocketSession
をConcurrentWebSocketSessionDecorator
でラップすることです。- 次で指定:
- インターフェース
WebSocketSession
のsendMessage
- 例外:
IOExceptionSE
- 関連事項:
close
インターフェースからコピーされた説明:WebSocketSession
WebSocket 接続をステータス 1000 で閉じます。session.close(CloseStatus.NORMAL);
- 次で指定:
- インターフェース
AutoCloseableSE
のclose
- 次で指定:
- インターフェース
CloseableSE
のclose
- 次で指定:
- インターフェース
WebSocketSession
のclose
- 例外:
IOExceptionSE
close
インターフェースからコピーされた説明:WebSocketSession
指定されたクローズ状態で WebSocket 接続を閉じます。- 次で指定:
- インターフェース
WebSocketSession
のclose
- 例外:
IOExceptionSE
toString