Packages

class Agent extends Object

The HTTP Agent is used for pooling sockets used in HTTP client requests. The HTTP Agent also defaults client requests to using Connection:keep-alive. If no pending HTTP requests are waiting on a socket to become free the socket is closed. This means that Node.js's pool has the benefit of keep-alive when under load but still does not require developers to manually close the HTTP clients using KeepAlive.

Annotations
@RawJSType() @native() @JSImport( "http" , "Agent" )
Linear Supertypes
Object, Any, AnyRef, Any
Known Subclasses
Agent
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Agent
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Agent(options: AgentOptions = js.native)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def createConnection(options: ConnectionOptions, callback: Function): Unit

    Produces a socket/stream to be used for HTTP requests.

    Produces a socket/stream to be used for HTTP requests. By default, this function is the same as net.createConnection(). However, custom Agents may override this method in case greater flexibility is desired.

    A socket/stream can be supplied in one of two ways: by returning the socket/stream from this function, or by passing the socket/stream to callback.

    callback has a signature of (err, stream).

    Example:

    1. agent.createConnection(options[, callback])

  7. def destroy(): Unit

    Destroy any sockets that are currently in use by the agent.

    Destroy any sockets that are currently in use by the agent.

    It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.

    Example:

    1. agent.destroy()

  8. def domain: String

    The agent's domain name

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def freeSockets: Object

    An object which contains arrays of sockets currently awaiting use by the Agent when HTTP KeepAlive is used.

    An object which contains arrays of sockets currently awaiting use by the Agent when HTTP KeepAlive is used. Do not modify.

    Example:

    1. agent.freeSockets

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getName(options: GetNameOptions): String
  15. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  19. def keepSocketAlive(socket: Socket): Unit
  20. var maxFreeSockets: Int

    By default set to 256.

    By default set to 256. For Agents supporting HTTP KeepAlive, this sets the maximum number of sockets that will be left open in the free state.

    Example:

    1. agent.maxFreeSockets

  21. var maxSockets: Int

    By default set to Infinity.

    By default set to Infinity. Determines how many concurrent sockets the agent can have open per origin. Origin is either a 'host:port' or 'host:port:localAddress' combination.

    Example:

    1. agent.maxSockets

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  26. def requests: Object

    An object which contains queues of requests that have not yet been assigned to sockets.

    An object which contains queues of requests that have not yet been assigned to sockets. Do not modify.

    Example:

    1. agent.requests

  27. def reuseSocket(socket: Socket, request: ClientRequest): Unit
  28. def sockets: Object

    An object which contains arrays of sockets currently in use by the Agent.

    An object which contains arrays of sockets currently in use by the Agent. Do not modify.

    Example:

    1. agent.sockets

  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toLocaleString(): String
    Definition Classes
    Object
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def valueOf(): Any
    Definition Classes
    Object
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped