クラス StompSubProtocolHandler

メソッドの詳細

• setErrorHandler

  public void setErrorHandler(StompSubProtocolErrorHandler errorHandler)

  クライアントに送信されるエラーメッセージのハンドラーを構成します。これにより、エラーメッセージをカスタマイズしたり、送信されないようにすることができます。

  デフォルトでは、これは設定されていません。その場合、エラーを反映するメッセージヘッダーとともに ERROR フレームが送信されます。

  パラメーター:

  errorHandler - エラーハンドラー

• getErrorHandler

  @Nullable public StompSubProtocolErrorHandler getErrorHandler()

  設定されたエラーハンドラーを返します。

• setMessageSizeLimit

  public void setMessageSizeLimit(int messageSizeLimit)

  受信 STOMP メッセージに許可される最大サイズを構成します。STOMP メッセージは複数の WebSocket メッセージで受信できるため、バッファリングが必要になる場合があり、許可される最大メッセージサイズを知る必要があります。

  デフォルトでは、このプロパティは 64K に設定されています。

  導入:

  4.0.3

• getMessageSizeLimit

  public int getMessageSizeLimit()

  設定されたメッセージバッファサイズの制限をバイト単位で取得します。

  導入:

  4.0.3

• setEncoder

  public void setEncoder(StompEncoder encoder)

  STOMP フレームのエンコード用に StompEncoder を構成します。

  導入:

  4.3.5

• setDecoder

  public void setDecoder(StompDecoder decoder)

  STOMP フレームをデコードするために StompDecoder を構成します。

  導入:

  4.3.5

• setHeaderInitializer

  public void setHeaderInitializer(@Nullable MessageHeaderInitializer headerInitializer)

  MessageHeaderInitializer を構成して、デコードされた STOMP フレームから作成されたすべてのメッセージと、クライアントの受信チャネルに送信された他のメッセージのヘッダーに適用します。

  デフォルトでは、このプロパティは設定されていません。

• getHeaderInitializer

  @Nullable public MessageHeaderInitializer getHeaderInitializer()

  設定済みのヘッダー初期化子を返します。

• setPreserveReceiveOrder

  public void setPreserveReceiveOrder(boolean preserveReceiveOrder)

  クライアントメッセージを受信した順序で処理する必要があるかどうか。

  デフォルトでは、"clientInboundChannel" に送信されたメッセージは同じ順序で処理されない可能性があります。これは、チャネルが ThreadPoolExecutor によってサポートされており、順序どおりに処理されることが保証されていないためです。

  このフラグが true に設定されている場合、同じセッション内のメッセージは、受信された順序を維持するために一度に 1 つずつ "clientInboundChannel" に送信されます。

  パラメーター:

  preserveReceiveOrder - 順番に公開するかどうか

  導入:

  6.1

• isPreserveReceiveOrder

  public boolean isPreserveReceiveOrder()

  ハンドラーが受信メッセージを受信した順序で処理するように構成されているかどうか。

  導入:

  6.1

• getSupportedProtocols

  public ListSE<StringSE> getSupportedProtocols()

  インターフェースからコピーされた説明: SubProtocolHandler

  このハンドラーでサポートされているサブプロトコルのリストを返します（非 null）。

  次で指定:

  インターフェース SubProtocolHandler の getSupportedProtocols 

• setApplicationEventPublisher

  public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

  インターフェースからコピーされた説明: ApplicationEventPublisherAware

  このオブジェクトが実行される ApplicationEventPublisher を設定します。

  通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet などの init コールバックやカスタム init メソッドの前に呼び出されます。ApplicationContextAware の setApplicationContext の前に呼び出されます。

  次で指定:

  インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher 

  パラメーター:

  applicationEventPublisher - このオブジェクトによって使用されるイベント発行元

• getStatsInfo

  public StringSE getStatsInfo()

  内部状態とカウンタを説明する文字列を返します。事実上、getStats() 上の toString()。

• getStats

  public StompSubProtocolHandler.Stats getStats()

  内部状態とカウンターを含む構造化オブジェクトを返します。

  導入:

  5.2

• handleMessageFromClient

  public void handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel targetChannel)

  クライアントからの受信 WebSocket メッセージを処理します。

  次で指定:

  インターフェース SubProtocolHandler の handleMessageFromClient 

  パラメーター:

  session - クライアントセッション

  webSocketMessage - クライアントメッセージ

  targetChannel - メッセージを送信する出力チャネル

• handleMessageToClient

  public void handleMessageToClient(WebSocketSession session, Message<?> message)

  WebSocket クライアントに戻る STOMP メッセージを処理します。

  次で指定:

  インターフェース SubProtocolHandler の handleMessageToClient 

  パラメーター:

  session - クライアントセッション

  message - クライアントメッセージ

• toMutableAccessor

  protected StompHeaderAccessor toMutableAccessor(StompHeaderAccessor headerAccessor, Message<?> message)

• resolveSessionId

  @Nullable public StringSE resolveSessionId(Message<?> message)

  インターフェースからコピーされた説明: SubProtocolHandler

  指定されたメッセージからセッション ID を解決するか、null を返します。

  次で指定:

  インターフェース SubProtocolHandler の resolveSessionId 

  パラメーター:

  message - セッション ID を解決するメッセージ

• afterSessionStarted

  public void afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)

  インターフェースからコピーされた説明: SubProtocolHandler

  WebSocketSession が開始した後に呼び出されます。

  次で指定:

  インターフェース SubProtocolHandler の afterSessionStarted 

  パラメーター:

  session - クライアントセッション

  outputChannel - チャンネル

• afterSessionEnded

  public void afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)

  インターフェースからコピーされた説明: SubProtocolHandler

  WebSocketSession が終了した後に呼び出されます。

  次で指定:

  インターフェース SubProtocolHandler の afterSessionEnded 

  パラメーター:

  session - クライアントセッション

  closeStatus - セッションが閉じられた理由

  outputChannel - チャンネル

• toString

  public StringSE toString()

  オーバーライド:

  クラス ObjectSE の toString