Package com.pushtechnology.diffusion.api.config

Interface TimeoutsConfig

All Superinterfaces:
Config
public interface TimeoutsConfig extends Config
Configuration of timeouts.
Since:
4.4

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getConnectionTimeout()
    Gets the connection timeout.
    long
    getWriteTimeout()
    Gets the write timeout value.
    void
    setConnectionTimeout(long timeout)
    Sets the connection timeout.
    void
    setWriteTimeout(long timeout)
    Sets the value of the write timeout for blocking write operations.

    Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

    isLocked

  • Method Details

    • setWriteTimeout

      void setWriteTimeout(long timeout) throws ConfigException
      Sets the value of the write timeout for blocking write operations.

      Most write operations are non-blocking and are not affected by this timeout.

      This constrains the time to write connection responses and the time to write HTTP responses to requests to the web server.

      If not specified then a value of 3 seconds is used.

      Parameters:
      timeout - value in milliseconds. If this exceeds one hour (3600000ms) a warning will be logged and the time-out will be set to one hour.
      Throws:
      ConfigException - if unable to set the property

    • getWriteTimeout

      long getWriteTimeout()
      Gets the write timeout value.
      Returns:
      write timeout in milliseconds

    • setConnectionTimeout

      void setConnectionTimeout(long timeout) throws ConfigException
      Sets the connection timeout.

      This value constrains the time taken to process the connection request and send the response. This includes the time taken to call any configured authentication handlers and look up location details.

      If this is not specified then a value of 5 seconds is used.

      Parameters:
      timeout - time in milliseconds. If this exceeds one hour (3600000ms) a warning will be logged and the timeout will be set to one hour.
      Throws:
      ConfigException - if unable to set the property

    • getConnectionTimeout

      long getConnectionTimeout()
      Gets the connection timeout.
      Returns:
      the connection timeout in milliseconds