クラス JettyWebSocketSession
java.lang.ObjectSE
org.springframework.web.socket.adapter.AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
- 実装されたすべてのインターフェース:
CloseableSE
、AutoCloseableSE
、NativeWebSocketSession
、WebSocketSession
public class JettyWebSocketSession
extends AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
Jetty WebSocket API で使用する
WebSocketSession
。- 導入:
- 4.0
- 作成者:
- Phillip Webb, Rossen Stoyanchev, Brian Clozel, Juergen Hoeller
フィールドサマリー
クラス org.springframework.web.socket.adapter.AbstractWebSocketSession から継承されたフィールド
idGenerator, logger
コンストラクターのサマリー
コンストラクター説明JettyWebSocketSession
(MapSE<StringSE, ObjectSE> attributes) 新しいJettyWebSocketSession
インスタンスを作成します。JettyWebSocketSession
(MapSE<StringSE, ObjectSE> attributes, PrincipalSE user) 指定されたユーザーに関連付けられた新しいJettyWebSocketSession
インスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明protected void
closeInternal
(CloseStatus status) ネゴシエートされたサブプロトコルを返します。int
受信バイナリメッセージの構成済みの最大サイズを取得します。ネゴシエートされた拡張機能を決定します。ハンドシェイクリクエストで使用されるヘッダーを返します(非null
)。getId()
一意のセッション識別子を返します。リクエストが受信されたアドレスを返します。認証されたユーザーの名前を含むPrincipal
SE インスタンスを返します。リモートクライアントのアドレスを返します。int
受信テキストメッセージの構成済みの最大サイズを取得します。getUri()
WebSocket 接続を開くために使用される URI を返します。void
initializeNativeSession
(org.eclipse.jetty.websocket.api.Session session) boolean
isOpen()
基になる接続が開いているかどうか。protected void
sendBinaryMessage
(BinaryMessage message) protected void
sendPingMessage
(PingMessage message) protected void
sendPongMessage
(PongMessage message) protected void
sendTextMessage
(TextMessage message) void
setBinaryMessageSizeLimit
(int messageSizeLimit) 受信バイナリメッセージの最大サイズを構成します。void
setTextMessageSizeLimit
(int messageSizeLimit) 受信テキストメッセージの最大サイズを構成します。クラス org.springframework.web.socket.adapter.AbstractWebSocketSession から継承されたメソッド
checkNativeSessionInitialized, close, close, getAttributes, getNativeSession, getNativeSession, sendMessage, toString
コンストラクターの詳細
JettyWebSocketSession
新しいJettyWebSocketSession
インスタンスを作成します。- パラメーター:
attributes
- WebSocket セッションに関連付ける HTTP ハンドシェイクの属性
JettyWebSocketSession
指定されたユーザーに関連付けられた新しいJettyWebSocketSession
インスタンスを作成します。- パラメーター:
attributes
- WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。提供された属性がコピーされ、元のマップは使用されません。user
- セッションに関連付けられているユーザー。null
の場合、Session.getUpgradeRequest()
を介して利用可能なユーザーにフォールバックします
メソッドの詳細
getId
インターフェースからコピーされた説明:WebSocketSession
一意のセッション識別子を返します。getUri
インターフェースからコピーされた説明:WebSocketSession
WebSocket 接続を開くために使用される URI を返します。getHandshakeHeaders
インターフェースからコピーされた説明:WebSocketSession
ハンドシェイクリクエストで使用されるヘッダーを返します(非null
)。getAcceptedProtocol
インターフェースからコピーされた説明:WebSocketSession
ネゴシエートされたサブプロトコルを返します。- 戻り値:
- プロトコル識別子、またはプロトコルが指定されていないか正常にネゴシエートされた場合は
null
getExtensions
インターフェースからコピーされた説明:WebSocketSession
ネゴシエートされた拡張機能を決定します。- 戻り値:
- 拡張機能のリスト、または拡張機能が指定されていないか正常にネゴシエートされていない場合は空のリスト
getPrincipal
インターフェースからコピーされた説明:WebSocketSession
認証されたユーザーの名前を含むPrincipal
SE インスタンスを返します。ユーザーが認証されていない場合、メソッドは
null
を返します。getLocalAddress
インターフェースからコピーされた説明:WebSocketSession
リクエストが受信されたアドレスを返します。getRemoteAddress
インターフェースからコピーされた説明:WebSocketSession
リモートクライアントのアドレスを返します。setTextMessageSizeLimit
public void setTextMessageSizeLimit(int messageSizeLimit) インターフェースからコピーされた説明:WebSocketSession
受信テキストメッセージの最大サイズを構成します。getTextMessageSizeLimit
public int getTextMessageSizeLimit()インターフェースからコピーされた説明:WebSocketSession
受信テキストメッセージの構成済みの最大サイズを取得します。setBinaryMessageSizeLimit
public void setBinaryMessageSizeLimit(int messageSizeLimit) インターフェースからコピーされた説明:WebSocketSession
受信バイナリメッセージの最大サイズを構成します。getBinaryMessageSizeLimit
public int getBinaryMessageSizeLimit()インターフェースからコピーされた説明:WebSocketSession
受信バイナリメッセージの構成済みの最大サイズを取得します。isOpen
public boolean isOpen()インターフェースからコピーされた説明:WebSocketSession
基になる接続が開いているかどうか。initializeNativeSession
public void initializeNativeSession(org.eclipse.jetty.websocket.api.Session session) - オーバーライド:
- クラス
AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
のinitializeNativeSession
sendTextMessage
- 次で指定:
- クラス
AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
のsendTextMessage
- 例外:
IOExceptionSE
sendBinaryMessage
- 次で指定:
- クラス
AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
のsendBinaryMessage
- 例外:
IOExceptionSE
sendPingMessage
- 次で指定:
- クラス
AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
のsendPingMessage
- 例外:
IOExceptionSE
sendPongMessage
- 次で指定:
- クラス
AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
のsendPongMessage
- 例外:
IOExceptionSE
closeInternal
- 次で指定:
- クラス
AbstractWebSocketSession<org.eclipse.jetty.websocket.api.Session>
のcloseInternal
- 例外:
IOExceptionSE