AbstractWebSocketSession (Spring Framework 5.1.5.RELEASE API)

java.lang.Object
- org.springframework.web.socket.adapter.AbstractWebSocketSession<T>

型パラメーター:
T - ネイティブセッション型
実装されたすべてのインターフェース:
java.io.Closeable, java.lang.AutoCloseable, NativeWebSocketSession, WebSocketSession
既知の直属サブクラス
JettyWebSocketSession, StandardWebSocketSession
```
public abstract class AbstractWebSocketSession<T>
extends java.lang.Object
implements NativeWebSocketSession
```
WebSocketSession の実装の抽象基本クラス。
導入:
4.0
作成者:
Rossen Stoyanchev

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected static IdGenerator idGenerator
protected static Log logger

フィールド
修飾子と型	フィールドと説明
`protected static IdGenerator`	`idGenerator`
`protected static Log`	`logger`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`AbstractWebSocketSession(java.util.Map<java.lang.String,java.lang.Object> attributes)` 新しいインスタンスを作成し、指定された属性をそれに関連付けます。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`checkNativeSessionInitialized()`
`void`	`close()` ステータス 1000 で WebSocket 接続を閉じます。
`void`	`close(CloseStatus status)` 指定されたクローズ状態で WebSocket 接続を閉じます。
`protected abstract void`	`closeInternal(CloseStatus status)`
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttributes()` WebSocket セッションに関連付けられた属性を持つマップを返します。
`T`	`getNativeSession()` 基礎となるネイティブ WebSocketSession を返します。
`<R> R`	`getNativeSession(java.lang.Class<R> requiredType)` 使用可能な場合、基礎となるネイティブ WebSocketSession を返します。
`void`	`initializeNativeSession(T session)`
`protected abstract void`	`sendBinaryMessage(BinaryMessage message)`
`void`	`sendMessage(WebSocketMessage<?> message)` WebSocket メッセージを送信する: `TextMessage` または `BinaryMessage` のいずれか。
`protected abstract void`	`sendPingMessage(PingMessage message)`
`protected abstract void`	`sendPongMessage(PongMessage message)`
`protected abstract void`	`sendTextMessage(TextMessage message)`
`java.lang.String`	`toString()`

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド
getAcceptedProtocol, getBinaryMessageSizeLimit, getExtensions, getHandshakeHeaders, getId, getLocalAddress, getPrincipal, getRemoteAddress, getTextMessageSizeLimit, getUri, isOpen, setBinaryMessageSizeLimit, setTextMessageSizeLimit

- フィールドの詳細
  - idGenerator
```
protected static final IdGenerator idGenerator
```
  - logger
```
protected static final Log logger
```
- コンストラクターの詳細
  - AbstractWebSocketSession
```
public AbstractWebSocketSession(@Nullable
                                java.util.Map<java.lang.String,java.lang.Object> attributes)
```
    新しいインスタンスを作成し、指定された属性をそれに関連付けます。
    パラメーター:
    attributes - WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。指定された属性はコピーされ、元のマップは使用されません。
- メソッドの詳細
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket セッションに関連付けられた属性を持つマップを返します。
    サーバー側では、最初に HandshakeInterceptor を介してマップにデータを入力できます。クライアント側では、WebSocketClient ハンドシェイクメソッドを介してマップにデータを入力できます。
    次で指定:
    インターフェース WebSocketSession の getAttributes
    戻り値:
    セッション属性を持つマップ (非 null)
  - getNativeSession
```
public T getNativeSession()
```
    インターフェースからコピーされた説明: NativeWebSocketSession
    基礎となるネイティブ WebSocketSession を返します。
    次で指定:
    インターフェース NativeWebSocketSession の getNativeSession
  - getNativeSession
```
@Nullable
public <R> R getNativeSession(@Nullable
                                        java.lang.Class<R> requiredType)
```
    インターフェースからコピーされた説明: NativeWebSocketSession
    使用可能な場合、基礎となるネイティブ WebSocketSession を返します。
    次で指定:
    インターフェース NativeWebSocketSession の getNativeSession
    パラメーター:
    requiredType - 必要なセッションの型
    戻り値:
    必要な型のネイティブセッション、または利用できない場合は null
  - initializeNativeSession
```
public void initializeNativeSession(T session)
```
  - checkNativeSessionInitialized
```
protected final void checkNativeSessionInitialized()
```
  - sendMessage
```
public final void sendMessage(WebSocketMessage<?> message)
                       throws java.io.IOException
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket メッセージを送信する: TextMessage または BinaryMessage のいずれか。
    注意 : 基礎となる標準 WebSocket セッション（JSR-356）は同時送信を許可しません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、WebSocketSession を ConcurrentWebSocketSessionDecorator でラップすることです。
    次で指定:
    インターフェース WebSocketSession の sendMessage
    例外:
    java.io.IOException
    関連事項:
    ConcurrentWebSocketSessionDecorator
  - sendTextMessage
```
protected abstract void sendTextMessage(TextMessage message)
                                 throws java.io.IOException
```
    例外:
    java.io.IOException
  - sendBinaryMessage
```
protected abstract void sendBinaryMessage(BinaryMessage message)
                                   throws java.io.IOException
```
    例外:
    java.io.IOException
  - sendPingMessage
```
protected abstract void sendPingMessage(PingMessage message)
                                 throws java.io.IOException
```
    例外:
    java.io.IOException
  - sendPongMessage
```
protected abstract void sendPongMessage(PongMessage message)
                                 throws java.io.IOException
```
    例外:
    java.io.IOException
  - close
```
public final void close()
                 throws java.io.IOException
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket 接続をステータス 1000 で閉じます。
```
 session.close(CloseStatus.NORMAL);
 
```
    次で指定:
    インターフェース java.io.Closeable の close
    次で指定:
    インターフェース java.lang.AutoCloseable の close
    次で指定:
    インターフェース WebSocketSession の close
    例外:
    java.io.IOException
  - close
```
public final void close(CloseStatus status)
                 throws java.io.IOException
```
    インターフェースからコピーされた説明: WebSocketSession
    指定されたクローズ状態で WebSocket 接続を閉じます。
    次で指定:
    インターフェース WebSocketSession の close
    例外:
    java.io.IOException
  - closeInternal
```
protected abstract void closeInternal(CloseStatus status)
                               throws java.io.IOException
```
    例外:
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス java.lang.Object の toString

クラス AbstractWebSocketSession<T>

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド

フィールドの詳細

idGenerator

logger

コンストラクターの詳細

AbstractWebSocketSession

メソッドの詳細

getAttributes

getNativeSession

getNativeSession

initializeNativeSession

checkNativeSessionInitialized

sendMessage

sendTextMessage

sendBinaryMessage

sendPingMessage

sendPongMessage

close

close

closeInternal

toString