Class ServletWebSocketBroadcaster

java.lang.Object
io.micronaut.servlet.websocket.ServletWebSocketBroadcaster
All Implemented Interfaces:
io.micronaut.websocket.WebSocketBroadcaster
@Internal @Singleton @Requires(classes=jakarta.websocket.server.ServerContainer.class) @Requires(beans=ServletWebSocketSessionRegistry.class) @Requires(property="micronaut.servlet.websocket.enabled",notEquals="false",defaultValue="true") public final class ServletWebSocketBroadcaster extends Object implements io.micronaut.websocket.WebSocketBroadcaster
A WebSocketBroadcaster that writes to every open session of this server.

Failures caused by a peer that has gone away are swallowed, matching the Netty broadcaster which ignores ClosedChannelException.

Since:
6.2.0
Author:
graemerocher

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServletWebSocketBroadcaster(ServletWebSocketSessionRegistry sessionRegistry)
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> org.reactivestreams.Publisher<T>
    broadcast(T message, io.micronaut.http.MediaType mediaType, Predicate<io.micronaut.websocket.WebSocketSession> filter)
     

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.micronaut.websocket.WebSocketBroadcaster

    broadcast, broadcast, broadcast, broadcastAsync, broadcastAsync, broadcastAsync, broadcastAsync, broadcastSync, broadcastSync, broadcastSync, broadcastSync

  • Constructor Details

    • ServletWebSocketBroadcaster

      public ServletWebSocketBroadcaster(ServletWebSocketSessionRegistry sessionRegistry)
      Default constructor.
      Parameters:
      sessionRegistry - The session registry

  • Method Details

    • broadcast

      public <T> org.reactivestreams.Publisher<T> broadcast(T message, io.micronaut.http.MediaType mediaType, Predicate<io.micronaut.websocket.WebSocketSession> filter)
      Specified by:
      broadcast in interface io.micronaut.websocket.WebSocketBroadcaster