public interface WebSocketSession extends CloseableSE
修飾子と型 | メソッドと説明 |
---|---|
void | close() ステータス 1000 で WebSocket 接続を閉じます。 |
void | close(CloseStatus status) 指定されたクローズ状態で WebSocket 接続を閉じます。 |
StringSE | getAcceptedProtocol() ネゴシエートされたサブプロトコルを返します。 |
MapSE<StringSE, ObjectSE> | getAttributes() WebSocket セッションに関連付けられた属性を持つマップを返します。 |
int | getBinaryMessageSizeLimit() 受信バイナリメッセージの構成済みの最大サイズを取得します。 |
ListSE<WebSocketExtension> | getExtensions() ネゴシエートされた拡張機能を決定します。 |
HttpHeaders | getHandshakeHeaders() ハンドシェイクリクエストで使用されるヘッダーを返します(非 null )。 |
StringSE | getId() 一意のセッション識別子を返します。 |
InetSocketAddressSE | getLocalAddress() リクエストが受信されたアドレスを返します。 |
PrincipalSE | getPrincipal() 認証されたユーザーの名前を含む Principal SE インスタンスを返します。 |
InetSocketAddressSE | getRemoteAddress() リモートクライアントのアドレスを返します。 |
int | getTextMessageSizeLimit() 受信テキストメッセージの構成済みの最大サイズを取得します。 |
URISE | getUri() WebSocket 接続を開くために使用される URI を返します。 |
boolean | isOpen() 基になる接続が開いているかどうか。 |
void | sendMessage(WebSocketMessage<?> message) WebSocket メッセージを送信する: TextMessage または BinaryMessage のいずれか。 |
void | setBinaryMessageSizeLimit(int messageSizeLimit) 受信バイナリメッセージの最大サイズを構成します。 |
void | setTextMessageSizeLimit(int messageSizeLimit) 受信テキストメッセージの最大サイズを構成します。 |
StringSE getId()
HttpHeaders getHandshakeHeaders()
null
)。MapSE<StringSE,ObjectSE> getAttributes()
サーバー側では、最初に HandshakeInterceptor
を介してマップにデータを入力できます。クライアント側では、WebSocketClient
ハンドシェイクメソッドを介してマップにデータを入力できます。
null
)@Nullable PrincipalSE getPrincipal()
Principal
SE インスタンスを返します。 ユーザーが認証されていない場合、メソッドは null
を返します。
@Nullable InetSocketAddressSE getLocalAddress()
@Nullable InetSocketAddressSE getRemoteAddress()
@Nullable StringSE getAcceptedProtocol()
null
void setTextMessageSizeLimit(int messageSizeLimit)
int getTextMessageSizeLimit()
void setBinaryMessageSizeLimit(int messageSizeLimit)
int getBinaryMessageSizeLimit()
ListSE<WebSocketExtension> getExtensions()
void sendMessage(WebSocketMessage<?> message) throws IOExceptionSE
TextMessage
または BinaryMessage
のいずれか。 注意 : 基盤となる標準の WebSocket セッション(JSR-356)では、同時送信は許可されていません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、WebSocketSession
を ConcurrentWebSocketSessionDecorator
でラップすることです。
boolean isOpen()
void close() throws IOExceptionSE
session.close(CloseStatus.NORMAL);
AutoCloseableSE
の closeSE
CloseableSE
の closeSE
IOExceptionSE
void close(CloseStatus status) throws IOExceptionSE