Module com.zeroc.ice
Package com.zeroc.Ice

Record Class ConnectionOptions

java.lang.Object
java.lang.Record
com.zeroc.Ice.ConnectionOptions
Record Components:
connectTimeout - the timeout for establishing a connection
closeTimeout - the timeout for closing a connection
idleTimeout - the timeout for an idle connection
enableIdleCheck - whether to enable idle connection checks
inactivityTimeout - the timeout for inactivity on a connection
maxDispatches - the maximum number of dispatches allowed on a connection before it is closed
public record ConnectionOptions(int connectTimeout, int closeTimeout, int idleTimeout, boolean enableIdleCheck, int inactivityTimeout, int maxDispatches) extends Record
Options for configuring the behavior of a connection. All timeouts are specified in seconds, and a timeout value of 0 or less indicates an infinite timeout.

  • Constructor Details

    • ConnectionOptions

      public ConnectionOptions(int connectTimeout, int closeTimeout, int idleTimeout, boolean enableIdleCheck, int inactivityTimeout, int maxDispatches)
      Creates an instance of a ConnectionOptions record class.
      Parameters:
      connectTimeout - the value for the connectTimeout record component
      closeTimeout - the value for the closeTimeout record component
      idleTimeout - the value for the idleTimeout record component
      enableIdleCheck - the value for the enableIdleCheck record component
      inactivityTimeout - the value for the inactivityTimeout record component
      maxDispatches - the value for the maxDispatches record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • connectTimeout

      public int connectTimeout()
      Returns the value of the connectTimeout record component.
      Returns:
      the value of the connectTimeout record component

    • closeTimeout

      public int closeTimeout()
      Returns the value of the closeTimeout record component.
      Returns:
      the value of the closeTimeout record component

    • idleTimeout

      public int idleTimeout()
      Returns the value of the idleTimeout record component.
      Returns:
      the value of the idleTimeout record component

    • enableIdleCheck

      public boolean enableIdleCheck()
      Returns the value of the enableIdleCheck record component.
      Returns:
      the value of the enableIdleCheck record component

    • inactivityTimeout

      public int inactivityTimeout()
      Returns the value of the inactivityTimeout record component.
      Returns:
      the value of the inactivityTimeout record component

    • maxDispatches

      public int maxDispatches()
      Returns the value of the maxDispatches record component.
      Returns:
      the value of the maxDispatches record component