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