Package io.undertow.websockets.jsr

Class WebSocketDeploymentInfo

java.lang.Object
io.undertow.websockets.jsr.WebSocketDeploymentInfo
All Implemented Interfaces:
Cloneable
public class WebSocketDeploymentInfo extends Object implements Cloneable
Web socket deployment information
Author:
Stuart Douglas

  • Field Details

  • Constructor Details

    • WebSocketDeploymentInfo

      public WebSocketDeploymentInfo()

  • Method Details

    • getWorker

      public Supplier<org.xnio.XnioWorker> getWorker()

    • setWorker

      public WebSocketDeploymentInfo setWorker(Supplier<org.xnio.XnioWorker> worker)

    • setWorker

      public WebSocketDeploymentInfo setWorker(org.xnio.XnioWorker worker)

    • getBuffers

      public io.undertow.connector.ByteBufferPool getBuffers()

    • setBuffers

      @Deprecated public WebSocketDeploymentInfo setBuffers(org.xnio.Pool<ByteBuffer> buffers)
      Deprecated.

    • setBuffers

      public WebSocketDeploymentInfo setBuffers(io.undertow.connector.ByteBufferPool buffers)

    • addEndpoint

      public WebSocketDeploymentInfo addEndpoint(Class<?> annotated)

    • addAnnotatedEndpoints

      public WebSocketDeploymentInfo addAnnotatedEndpoints(Collection<Class<?>> annotatedEndpoints)

    • addEndpoint

      public WebSocketDeploymentInfo addEndpoint(jakarta.websocket.server.ServerEndpointConfig endpoint)

    • addProgramaticEndpoints

      public WebSocketDeploymentInfo addProgramaticEndpoints(Collection<jakarta.websocket.server.ServerEndpointConfig> programaticEndpoints)

    • getAnnotatedEndpoints

      public List<Class<?>> getAnnotatedEndpoints()

    • getProgramaticEndpoints

      public List<jakarta.websocket.server.ServerEndpointConfig> getProgramaticEndpoints()

    • addListener

      public WebSocketDeploymentInfo addListener(WebSocketDeploymentInfo.ContainerReadyListener listener)

    • addListeners

      public WebSocketDeploymentInfo addListeners(Collection<WebSocketDeploymentInfo.ContainerReadyListener> listeners)

    • getListeners

      public List<WebSocketDeploymentInfo.ContainerReadyListener> getListeners()

    • isDispatchToWorkerThread

      public boolean isDispatchToWorkerThread()

    • setDispatchToWorkerThread

      public WebSocketDeploymentInfo setDispatchToWorkerThread(boolean dispatchToWorkerThread)

    • addExtension

      public WebSocketDeploymentInfo addExtension(io.undertow.websockets.extensions.ExtensionHandshake extension)
      Add a new WebSocket Extension into this deployment info.
      Parameters:
      extension - a new ExtensionHandshake instance
      Returns:
      current deployment info

    • addExtensions

      public WebSocketDeploymentInfo addExtensions(Collection<io.undertow.websockets.extensions.ExtensionHandshake> extensions)

    • getExtensions

      public List<io.undertow.websockets.extensions.ExtensionHandshake> getExtensions()
      Returns:
      list of extensions available for this deployment info

    • getClientBindAddress

      public String getClientBindAddress()

    • setClientBindAddress

      public WebSocketDeploymentInfo setClientBindAddress(String clientBindAddress)

    • getReconnectHandler

      public WebSocketReconnectHandler getReconnectHandler()

    • setReconnectHandler

      public WebSocketDeploymentInfo setReconnectHandler(WebSocketReconnectHandler reconnectHandler)

    • getDefaultAsyncSendTimeout

      public long getDefaultAsyncSendTimeout()
      Get default web-socket async send timeout in milliseconds. Defaults to: 30000
      Returns:

    • setDefaultAsyncSendTimeout

      public WebSocketDeploymentInfo setDefaultAsyncSendTimeout(long defaultAsyncSendTimeout)
      Parameters:
      defaultAsyncSendTimeout - - defualt web-socket async send in milliseconds.
      Returns:

    • getDefaultMaxSessionIdleTimeout

      public long getDefaultMaxSessionIdleTimeout()
      default web-socket idling timeout for session in seconds, defaults to 30 minutes.
      Returns:

    • setDefaultMaxSessionIdleTimeout

      public WebSocketDeploymentInfo setDefaultMaxSessionIdleTimeout(long defaultMaxSessionIdleTimeout)
      Set default web-socket idling timeout in seconds.
      Parameters:
      defaultMaxSessionIdleTimeout -
      Returns:

    • getDefaultMaxBinaryMessageBufferSize

      public int getDefaultMaxBinaryMessageBufferSize()
      Get default binary messages size in Byte, defaults to 128KB
      Returns:

    • setDefaultMaxBinaryMessageBufferSize

      public WebSocketDeploymentInfo setDefaultMaxBinaryMessageBufferSize(int defaultMaxBinaryMessageBufferSize)
      Set default max binary size in Bytes.
      Parameters:
      defaultMaxBinaryMessageBufferSize -
      Returns:

    • getDefaultMaxTextMessageBufferSize

      public int getDefaultMaxTextMessageBufferSize()
      Get default text messages size in Byte, defaults to 128KB
      Returns:

    • setDefaultMaxTextMessageBufferSize

      public WebSocketDeploymentInfo setDefaultMaxTextMessageBufferSize(int defaultMaxTextMessageBufferSize)
      Set default max text size in Bytes.
      Parameters:
      defaultMaxTextMessageBufferSize -
      Returns:

    • clone

      public WebSocketDeploymentInfo clone()
      Overrides:
      clone in class Object