cc.spray.can

ClientConfig

case class ClientConfig (clientActorId: String, userAgentHeader: String, readBufferSize: Int, idleTimeout: Long, reapingCycle: Long, requestTimeout: Long, timeoutCycle: Long, parserConfig: MessageParserConfig) extends PeerConfig with Product with Serializable

The ClientConfig configures an instance of the HttpClient actor.

clientActorId

the actor id the HttpClient is to receive, default is spray-can-server

userAgentHeader

the value of the "User-Agent" request header set by the HttpClient, if empty the "User-Agent" request header will not be rendered

Linear Supertypes
Serializable, Serializable, Product, Equals, PeerConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ClientConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PeerConfig
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClientConfig (clientActorId: String, userAgentHeader: String, readBufferSize: Int, idleTimeout: Long, reapingCycle: Long, requestTimeout: Long, timeoutCycle: Long, parserConfig: MessageParserConfig)

    Creates a new ClientConfig

    Creates a new ClientConfig

    clientActorId

    the actor id the HttpClient is to receive, default is spray-can-server

    userAgentHeader

    the value of the "User-Agent" request header set by the HttpClient, if empty the "User-Agent" request header will not be rendered

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def canEqual (arg0: Any): Boolean

    Definition Classes
    ClientConfig → Equals
  8. val clientActorId : String

    the actor id the HttpClient is to receive, default is spray-can-server

  9. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  11. def equals (arg0: Any): Boolean

    Definition Classes
    ClientConfig → Equals → AnyRef → Any
  12. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  14. def hashCode (): Int

    Definition Classes
    ClientConfig → AnyRef → Any
  15. val idleTimeout : Long

    The time period in milliseconds that an open HTTP connection has to be idle before automatically being closed.

    The time period in milliseconds that an open HTTP connection has to be idle before automatically being closed. Set to zero to disable connection timeouts.

    Default: 10,000 ms = 10 seconds

    Definition Classes
    ClientConfigPeerConfig
  16. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  17. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  18. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  19. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  20. val parserConfig : MessageParserConfig

    The configuration of the spray-can message parser.

    The configuration of the spray-can message parser.

    Definition Classes
    ClientConfigPeerConfig
  21. def productArity : Int

    Definition Classes
    ClientConfig → Product
  22. def productElement (arg0: Int): Any

    Definition Classes
    ClientConfig → Product
  23. def productIterator : Iterator[Any]

    Definition Classes
    Product
  24. def productPrefix : String

    Definition Classes
    ClientConfig → Product
  25. val readBufferSize : Int

    The size of the read buffer used for processing incoming messages.

    The size of the read buffer used for processing incoming messages. Usually there should be little reason to configure it to a value different from its default of 8192 (bytes).

    Definition Classes
    ClientConfigPeerConfig
  26. val reapingCycle : Long

    The reapingCycle is the time in milliseconds between two runs of the "reaper", which is the logic that closes open HTTP connections whose idle timeout has exceeded the configured value.

    The reapingCycle is the time in milliseconds between two runs of the "reaper", which is the logic that closes open HTTP connections whose idle timeout has exceeded the configured value. Larger values (very slightly) increase overall server or client efficiency (since less time is being spent looking for timed out connections) whereas smaller values increase the precision with which idle connections are really closed after the configured idle timeout. The default value is 500, which means that the reaper runs twice per second.

    Definition Classes
    ClientConfigPeerConfig
  27. val requestTimeout : Long

    The time period in milliseconds that are response has to be produced by the application (in the case of the ServerConfig) or received by the server (in the case of the ClientConfig.

    The time period in milliseconds that are response has to be produced by the application (in the case of the ServerConfig) or received by the server (in the case of the ClientConfig. Set to zero to disable request timeouts. The default value is 5000 ms = 5 seconds.

    Definition Classes
    ClientConfigPeerConfig
  28. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  29. val timeoutCycle : Long

    The timeoutCycle is the time in milliseconds between two runs of the logic that determines which of all open requests have timed out.

    The timeoutCycle is the time in milliseconds between two runs of the logic that determines which of all open requests have timed out. Larger values (very slightly) increase overall server or client efficiency (since less time is being spent looking for timed out requests) whereas smaller values increase the precision with which timed out requests are really reacted on after the configured timeout time has elapsed. The default value is 200.

    Definition Classes
    ClientConfigPeerConfig
  30. def toString (): String

    Definition Classes
    ClientConfig → AnyRef → Any
  31. val userAgentHeader : String

    the value of the "User-Agent" request header set by the HttpClient, if empty the "User-Agent" request header will not be rendered

  32. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  34. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PeerConfig

Inherited from AnyRef

Inherited from Any