クラス GraphQlWebSocketHandler
java.lang.ObjectSE
org.springframework.web.socket.handler.AbstractWebSocketHandler
org.springframework.web.socket.handler.TextWebSocketHandler
org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
- 実装済みのインターフェース一覧:
SubProtocolCapable,WebSocketHandler
@RegisterReflectionForBinding(GraphQlWebSocketMessage.class)
public class GraphQlWebSocketHandler
extends TextWebSocketHandler
implements SubProtocolCapable
WebSocket プロトコル上の GraphQL に基づく GraphQL 用の WebSocketHandler および
spring-websocket を使用するサーブレットコンテナーで使用するための WebSocketHandler。- 導入:
- 1.0.0
- 作成者:
- Rossen Stoyanchev
コンストラクター概要
コンストラクターコンストラクター説明GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler, HttpMessageConverter<ObjectSE> converter, DurationSE connectionInitTimeout) 新しいインスタンスを作成します。GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler, HttpMessageConverter<ObjectSE> converter, DurationSE connectionInitTimeout, @Nullable DurationSE keepAliveDuration) 新しいインスタンスを作成します。方法の概要
修飾子と型メソッド説明voidafterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) voidprotected voidhandleTextMessage(WebSocketSession session, TextMessage webSocketMessage) initWebSocketHttpRequestHandler(HandshakeHandler handshakeHandler) このインスタンスをラップするWebSocketHttpRequestHandlerを初期化し、コンテキスト伝搬のためにHandshakeInterceptorも挿入します。クラス org.springframework.web.socket.handler.TextWebSocketHandler から継承されたメソッド
handleBinaryMessageクラス org.springframework.web.socket.handler.AbstractWebSocketHandler から継承されたメソッド
handleMessage, handlePongMessage, handleTransportError, supportsPartialMessages
コンストラクターの詳細
GraphQlWebSocketHandler
public GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler, HttpMessageConverter<ObjectSE> converter, DurationSE connectionInitTimeout) 新しいインスタンスを作成します。- パラメーター:
graphQlHandler- GraphQL over WebSocket リクエストの共通ハンドラーconverter- JSON のエンコードとデコード用connectionInitTimeout- WebSocket の確立後、クライアントからの"connection_ini"メッセージを待機する時間。
GraphQlWebSocketHandler
public GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler, HttpMessageConverter<ObjectSE> converter, DurationSE connectionInitTimeout, @Nullable DurationSE keepAliveDuration) 新しいインスタンスを作成します。- パラメーター:
graphQlHandler- GraphQL over WebSocket リクエストの共通ハンドラーconverter- JSON のエンコードとデコード用connectionInitTimeout- WebSocket の確立後、クライアントからの"connection_ini"メッセージを待機する時間。keepAliveDuration- 他のメッセージが送信されていない場合に ping メッセージを送信する頻度- 導入:
- 1.3.0
メソッドの詳細
getSubProtocols
- 次で指定:
- インターフェース
SubProtocolCapableのgetSubProtocols
initWebSocketHttpRequestHandler
public WebSocketHttpRequestHandler initWebSocketHttpRequestHandler(HandshakeHandler handshakeHandler) このインスタンスをラップするWebSocketHttpRequestHandlerを初期化し、コンテキスト伝搬のためにHandshakeInterceptorも挿入します。- パラメーター:
handshakeHandler- WebSocket ハンドシェイクのハンドラー- 導入:
- 1.1.0
afterConnectionEstablished
- 次で指定:
- インターフェース
WebSocketHandlerのafterConnectionEstablished - オーバーライド:
- クラス
AbstractWebSocketHandlerのafterConnectionEstablished
handleTextMessage
protected void handleTextMessage(WebSocketSession session, TextMessage webSocketMessage) throws ExceptionSE - オーバーライド:
- クラス
AbstractWebSocketHandlerのhandleTextMessage - 例外:
ExceptionSE
afterConnectionClosed
- 次で指定:
- インターフェース
WebSocketHandlerのafterConnectionClosed - オーバーライド:
- クラス
AbstractWebSocketHandlerのafterConnectionClosed