クラス WebSocketServerSockJsSession
java.lang.ObjectSE
org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
- 実装されたすべてのインターフェース:
CloseableSE
、AutoCloseableSE
、NativeWebSocketSession
、SockJsSession
、WebSocketSession
public class WebSocketServerSockJsSession
extends AbstractSockJsSession
implements NativeWebSocketSession
WebSocket トランスポートで使用する SockJS セッション。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller
フィールドサマリー
クラス org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession から継承されたフィールド
DISCONNECTED_CLIENT_LOG_CATEGORY, logger, responseLock
コンストラクターのサマリー
コンストラクター説明WebSocketServerSockJsSession
(StringSE id, SockJsServiceConfig config, WebSocketHandler handler, MapSE<StringSE, ObjectSE> attributes) メソッドのサマリー
修飾子と型メソッド説明protected void
disconnect
(CloseStatus status) 実際に基になる WebSocket セッションを閉じるか、HTTP トランスポートの場合は基になるリクエストを完了します。ネゴシエートされたサブプロトコルを返します。int
受信バイナリメッセージの構成済みの最大サイズを取得します。ネゴシエートされた拡張機能を決定します。ハンドシェイクリクエストで使用されるヘッダーを返します(非null
)。リクエストが受信されたアドレスを返します。基礎となるネイティブ WebSocketSession を返します。<T> T
getNativeSession
(ClassSE<T> requiredType) 使用可能な場合、基礎となるネイティブ WebSocketSession を返します。認証されたユーザーの名前を含むPrincipal
SE インスタンスを返します。リモートクライアントのアドレスを返します。int
受信テキストメッセージの構成済みの最大サイズを取得します。getUri()
WebSocket 接続を開くために使用される URI を返します。void
handleMessage
(TextMessage message, WebSocketSession wsSession) void
boolean
isActive()
ポーリングセッションとストリーミングセッションは、定期的に現在の HTTP リクエストを閉じ、次のリクエストが送信されるのを待ちます。void
sendMessageInternal
(StringSE message) void
setBinaryMessageSizeLimit
(int messageSizeLimit) 受信バイナリメッセージの最大サイズを構成します。void
setTextMessageSizeLimit
(int messageSizeLimit) 受信テキストメッセージの最大サイズを構成します。protected void
writeFrameInternal
(SockJsFrame frame) クラス org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession から継承されたメソッド
cancelHeartbeat, close, close, delegateConnectionClosed, delegateConnectionEstablished, delegateError, delegateMessages, disableHeartbeat, getAttributes, getId, getMessageCodec, getSockJsServiceConfig, getTimeSinceLastActive, isClosed, isNew, isOpen, scheduleHeartbeat, sendHeartbeat, sendMessage, toString, tryCloseWithSockJsTransportError, updateLastActiveTime, writeFrame
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド
close, close, getAttributes, getId, isOpen, sendMessage
コンストラクターの詳細
WebSocketServerSockJsSession
public WebSocketServerSockJsSession(StringSE id, SockJsServiceConfig config, WebSocketHandler handler, @Nullable MapSE<StringSE, ObjectSE> attributes)
メソッドの詳細
getUri
インターフェースからコピーされた説明:WebSocketSession
WebSocket 接続を開くために使用される URI を返します。- 次で指定:
- インターフェース
WebSocketSession
のgetUri
getHandshakeHeaders
インターフェースからコピーされた説明:WebSocketSession
ハンドシェイクリクエストで使用されるヘッダーを返します(非null
)。- 次で指定:
- インターフェース
WebSocketSession
のgetHandshakeHeaders
getPrincipal
インターフェースからコピーされた説明:WebSocketSession
認証されたユーザーの名前を含むPrincipal
SE インスタンスを返します。ユーザーが認証されていない場合、メソッドは
null
を返します。- 次で指定:
- インターフェース
WebSocketSession
のgetPrincipal
getLocalAddress
インターフェースからコピーされた説明:WebSocketSession
リクエストが受信されたアドレスを返します。- 次で指定:
- インターフェース
WebSocketSession
のgetLocalAddress
getRemoteAddress
インターフェースからコピーされた説明:WebSocketSession
リモートクライアントのアドレスを返します。- 次で指定:
- インターフェース
WebSocketSession
のgetRemoteAddress
getAcceptedProtocol
インターフェースからコピーされた説明:WebSocketSession
ネゴシエートされたサブプロトコルを返します。- 次で指定:
- インターフェース
WebSocketSession
のgetAcceptedProtocol
- 戻り値:
- プロトコル識別子、またはプロトコルが指定されていないか正常にネゴシエートされた場合は
null
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
getExtensions
インターフェースからコピーされた説明:WebSocketSession
ネゴシエートされた拡張機能を決定します。- 次で指定:
- インターフェース
WebSocketSession
のgetExtensions
- 戻り値:
- 拡張機能のリスト、または拡張機能が指定されていないか正常にネゴシエートされていない場合は空のリスト
getNativeSession
インターフェースからコピーされた説明:NativeWebSocketSession
基礎となるネイティブ WebSocketSession を返します。- 次で指定:
- インターフェース
NativeWebSocketSession
のgetNativeSession
getNativeSession
インターフェースからコピーされた説明:NativeWebSocketSession
使用可能な場合、基礎となるネイティブ WebSocketSession を返します。- 次で指定:
- インターフェース
NativeWebSocketSession
のgetNativeSession
- パラメーター:
requiredType
- 必要なセッションの型- 戻り値:
- 必要な型のネイティブセッション、または利用できない場合は
null
initializeDelegateSession
isActive
public boolean isActive()クラスからコピーされた説明:AbstractSockJsSession
ポーリングセッションとストリーミングセッションは、定期的に現在の HTTP リクエストを閉じ、次のリクエストが送信されるのを待ちます。この「ダウンタイム」の間、セッションはまだ開いていますが、非アクティブであり、メッセージを送信できないため、メッセージを一時的にバッファする必要があります。対照的に、WebSocket セッションはステートフルであり、閉じられるまでアクティブのままです。- 次で指定:
- クラス
AbstractSockJsSession
のisActive
handleMessage
- 例外:
ExceptionSE
sendMessageInternal
writeFrameInternal
- 次で指定:
- クラス
AbstractSockJsSession
のwriteFrameInternal
- 例外:
IOExceptionSE
disconnect
クラスからコピーされた説明:AbstractSockJsSession
実際に基になる WebSocket セッションを閉じるか、HTTP トランスポートの場合は基になるリクエストを完了します。- 次で指定:
- クラス
AbstractSockJsSession
のdisconnect
- 例外:
IOExceptionSE