AbstractWebSocketSession (Spring Framework 5.1.1.RELEASE API)

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

型パラメーター:
T - ネイティブデリゲート型
実装済みのインターフェース一覧:
WebSocketSession
既知の直属サブクラス
AbstractListenerWebSocketSession, NettyWebSocketSessionSupport
```
public abstract class AbstractWebSocketSession<T>
extends java.lang.Object
implements WebSocketSession
```
共通フィールドを保持し、アクセサーを公開する WebSocketSession 実装の便利な基本クラス。WebSocketMessage ファクトリメソッドも実装します。
導入:
5.0
作成者:
Rossen Stoyanchev

フィールド概要
フィールド
修飾子と型フィールドと説明
protected Log logger

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

コンストラクター概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractWebSocketSession(T delegate, java.lang.String id, HandshakeInfo info, DataBufferFactory bufferFactory)` 新しい WebSocket セッションを作成します。

方法の概要

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`WebSocketMessage`	`binaryMessage(java.util.function.Function<DataBufferFactory, DataBuffer> payloadFactory)` セッションに `WebSocketSession.bufferFactory()` を使用してバイナリ WebSocketMessage を作成するファクトリメソッド。
`DataBufferFactory`	`bufferFactory()` メッセージペイロードを作成する `DataBuffer` ファクトリを返します。
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttributes()` WebSocket セッションに関連付けられた属性を持つマップを返します。
`protected T`	`getDelegate()`
`HandshakeInfo`	`getHandshakeInfo()` ハンドシェイクリクエストから情報を返します。
`java.lang.String`	`getId()` セッションの ID を返します。
`protected java.lang.String`	`getLogPrefix()`
`WebSocketMessage`	`pingMessage(java.util.function.Function<DataBufferFactory, DataBuffer> payloadFactory)` セッションに `WebSocketSession.bufferFactory()` を使用して ping WebSocketMessage を作成するファクトリメソッド。
`WebSocketMessage`	`pongMessage(java.util.function.Function<DataBufferFactory, DataBuffer> payloadFactory)` セッションに `WebSocketSession.bufferFactory()` を使用してポン WebSocketMessage を作成するファクトリメソッド。
`abstract reactor.core.publisher.Flux<WebSocketMessage>`	`receive()` 受信メッセージのストリームへのアクセスを提供します。
`abstract reactor.core.publisher.Mono<java.lang.Void>`	`send(org.reactivestreams.Publisher<WebSocketMessage> messages)` 発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了する `Mono<Void>` を返します。
`WebSocketMessage`	`textMessage(java.lang.String payload)` セッションに `WebSocketSession.bufferFactory()` を使用してテキスト `WebSocketMessage` を作成するファクトリメソッド。
`java.lang.String`	`toString()`

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

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

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - AbstractWebSocketSession
```
protected AbstractWebSocketSession(T delegate,
                                   java.lang.String id,
                                   HandshakeInfo info,
                                   DataBufferFactory bufferFactory)
```
    新しい WebSocket セッションを作成します。
- メソッドの詳細
  - getDelegate
```
protected T getDelegate()
```
  - getId
```
public java.lang.String getId()
```
    インターフェースからコピーされた説明: WebSocketSession
    セッションの ID を返します。
    次で指定:
    インターフェース WebSocketSession 内の getId
  - getHandshakeInfo
```
public HandshakeInfo getHandshakeInfo()
```
    インターフェースからコピーされた説明: WebSocketSession
    ハンドシェイクリクエストから情報を返します。
    次で指定:
    インターフェース WebSocketSession 内の getHandshakeInfo
  - bufferFactory
```
public DataBufferFactory bufferFactory()
```
    インターフェースからコピーされた説明: WebSocketSession
    メッセージペイロードを作成する DataBuffer ファクトリを返します。
    次で指定:
    インターフェース WebSocketSession 内の bufferFactory
    戻り値:
    セッションのバッファファクトリ
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket セッションに関連付けられた属性を持つマップを返します。
    次で指定:
    インターフェース WebSocketSession 内の getAttributes
    戻り値:
    セッション属性を持つマップ (決して null ではない)
  - getLogPrefix
```
protected java.lang.String getLogPrefix()
```
  - receive
```
public abstract reactor.core.publisher.Flux<WebSocketMessage> receive()
```
    インターフェースからコピーされた説明: WebSocketSession
    受信メッセージのストリームへのアクセスを提供します。
    このストリームは、接続が閉じられたときに完了またはエラーシグナルを受け取ります。典型的な WebSocketHandler 実装では、このストリームは全体的な処理フローに組み込まれるため、接続が閉じられると処理が終了します。
    セッションの処理方法の詳細と例については、WebSocketHandler のクラスレベルのドキュメントとリファレンスを参照してください。
    次で指定:
    インターフェース WebSocketSession 内の receive
  - send
```
public abstract reactor.core.publisher.Mono<java.lang.Void> send(org.reactivestreams.Publisher<WebSocketMessage> messages)
```
    インターフェースからコピーされた説明: WebSocketSession
    発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了する Mono<Void> を返します。
    セッションの処理方法の詳細と例については、WebSocketHandler のクラスレベルのドキュメントとリファレンスを参照してください。
    次で指定:
    インターフェース WebSocketSession 内の send
  - textMessage
```
public WebSocketMessage textMessage(java.lang.String payload)
```
    インターフェースからコピーされた説明: WebSocketSession
    セッションに WebSocketSession.bufferFactory() を使用してテキスト WebSocketMessage を作成するファクトリメソッド。
    次で指定:
    インターフェース WebSocketSession 内の textMessage
  - binaryMessage
```
public WebSocketMessage binaryMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory)
```
    インターフェースからコピーされた説明: WebSocketSession
    セッションに WebSocketSession.bufferFactory() を使用してバイナリ WebSocketMessage を作成するファクトリメソッド。
    次で指定:
    インターフェース WebSocketSession 内の binaryMessage
  - pingMessage
```
public WebSocketMessage pingMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory)
```
    インターフェースからコピーされた説明: WebSocketSession
    セッションに WebSocketSession.bufferFactory() を使用して ping WebSocketMessage を作成するファクトリメソッド。
    次で指定:
    インターフェース WebSocketSession 内の pingMessage
  - pongMessage
```
public WebSocketMessage pongMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory)
```
    インターフェースからコピーされた説明: WebSocketSession
    セッションに WebSocketSession.bufferFactory() を使用してポン WebSocketMessage を作成するファクトリメソッド。
    次で指定:
    インターフェース WebSocketSession 内の pongMessage
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス java.lang.Object の toString

クラス AbstractWebSocketSession<T>

フィールド概要

コンストラクター概要

方法の概要

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

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

フィールドの詳細

logger

コンストラクターの詳細

AbstractWebSocketSession

メソッドの詳細

getDelegate

getId

getHandshakeInfo

bufferFactory

getAttributes

getLogPrefix

receive

send

textMessage

binaryMessage

pingMessage

pongMessage

toString