Module io.helidon.nima.webserver
Package io.helidon.nima.webserver

Class ListenerConfiguration

java.lang.Object
io.helidon.nima.webserver.ListenerConfiguration
public final class ListenerConfiguration extends Object
Configuration of a server listener (server socket).

  • Method Details

    • builder

      public static ListenerConfiguration.Builder builder(String socketName)
      Create a new builder for a named socket.
      Parameters:
      socketName - name of the listener
      Returns:
      a new builder

    • create

      public static ListenerConfiguration create(String socketName)
      Create a default configuration, listening on a random port and on localhost.
      Parameters:
      socketName - name of the socket to create default configuration for
      Returns:
      a new default socket configuration

    • configureSocket

      public void configureSocket(ServerSocket socket)
      Update the server socket with configured socket options.
      Parameters:
      socket - socket to update

    • writeQueueLength

      public int writeQueueLength()
      Maximal number of buffers to be queued in the write queue (when used).
      Returns:
      write queue length

    • contentEncodingContext

      public ContentEncodingContext contentEncodingContext()
      Content encoding context of this listener.
      Returns:
      content encoding context, never null

    • mediaContext

      public MediaContext mediaContext()
      Media context of this listener.
      Returns:
      media context, never null

    • maxPayloadSize

      public long maxPayloadSize()
      Maximal payload size (in bytes).
      Returns:
      maximal allowed payload size

    • writeBufferSize

      public int writeBufferSize()
      Initial buffer size of BufferedOutputStream created internally.
      Returns:
      initial buffer size for writing (in bytes)

    • directHandlers

      public DirectHandlers directHandlers()
      Configured direct handlers.
      Returns:
      direct handlers

    • context

      public Context context()
      Configured context.
      Returns:
      context

    • requestedUriDiscoveryContext

      public RequestedUriDiscoveryContext requestedUriDiscoveryContext()
      Requuested URI discovery context.
      Returns:
      discovery context