Module swim.io
Package swim.io

Class TransportSettings

java.lang.Object
swim.io.TransportSettings
All Implemented Interfaces:
swim.codec.Debug
public class TransportSettings extends Object implements swim.codec.Debug
Transport configuration parameters.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final int
    backlog
     
    protected final long
    idleInterval
     
    protected final long
    idleTimeout
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TransportSettings(int backlog, long idleInterval, long idleTimeout)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final int
    backlog()
    Returns the maximum length of the queue of incoming connections.
    TransportSettings
    backlog(int backlog)
    Returns a copy of these TransportSettings configured with the given backlog for the maximum length of the queue of incoming connections.
    boolean
    canEqual(Object other)
    Returns true if these TransportSettings can possibly equal some other object.
    protected TransportSettings
    copy(int backlog, long idleInterval, long idleTimeout)
    Returns a new TransportSettings instance with the given options.
    <T> swim.codec.Output<T>
    debug(swim.codec.Output<T> output)
     
    boolean
    equals(Object other)
     
    static swim.structure.Form<TransportSettings>
    form()
    Returns the structural Form of TransportSettings.
    int
    hashCode()
     
    final long
    idleInterval()
    Returns the number of milliseconds between transport idle checks.
    TransportSettings
    idleInterval(long idleInterval)
    Returns a copy of these TransportSettings configured with the given idleInterval for transport idle checks.
    final long
    idleTimeout()
    Returns the default number of idle milliseconds after which a transport should be timed out due to inactivity.
    TransportSettings
    idleTimeout(long idleTimeout)
    Returns a copy of these TransportSettings configured with the given idleTimeout for transport idle timeouts
    static TransportSettings
    standard()
    Returns the default TransportSettings instance.
    String
    toString()
     
    swim.structure.Value
    toValue()
    Returns a structural Value representing these TransportSettings.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • backlog

      protected final int backlog

    • idleInterval

      protected final long idleInterval

    • idleTimeout

      protected final long idleTimeout

  • Constructor Details

    • TransportSettings

      public TransportSettings(int backlog, long idleInterval, long idleTimeout)

  • Method Details

    • backlog

      public final int backlog()
      Returns the maximum length of the queue of incoming connections.

    • backlog

      public TransportSettings backlog(int backlog)
      Returns a copy of these TransportSettings configured with the given backlog for the maximum length of the queue of incoming connections.

    • idleInterval

      public final long idleInterval()
      Returns the number of milliseconds between transport idle checks.

    • idleInterval

      public TransportSettings idleInterval(long idleInterval)
      Returns a copy of these TransportSettings configured with the given idleInterval for transport idle checks.

    • idleTimeout

      public final long idleTimeout()
      Returns the default number of idle milliseconds after which a transport should be timed out due to inactivity.

    • idleTimeout

      public TransportSettings idleTimeout(long idleTimeout)
      Returns a copy of these TransportSettings configured with the given idleTimeout for transport idle timeouts

    • copy

      protected TransportSettings copy(int backlog, long idleInterval, long idleTimeout)
      Returns a new TransportSettings instance with the given options. Subclasses may override this method to ensure the proper class is instantiated when updating settings.

    • toValue

      public swim.structure.Value toValue()
      Returns a structural Value representing these TransportSettings.

    • canEqual

      public boolean canEqual(Object other)
      Returns true if these TransportSettings can possibly equal some other object.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • debug

      public <T> swim.codec.Output<T> debug(swim.codec.Output<T> output)
      Specified by:
      debug in interface swim.codec.Debug

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • standard

      public static TransportSettings standard()
      Returns the default TransportSettings instance.

    • form

      @Kind public static swim.structure.Form<TransportSettings> form()
      Returns the structural Form of TransportSettings.