Packages

class Agent extends http.Agent

HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a separate module.

Annotations
@JSType() @native() @JSImport( "https" , "Agent" )
Linear Supertypes
http.Agent, IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Agent
  2. Agent
  3. IEventEmitter
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Agent(options: AgentOptions)
  2. new Agent()

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. def addListener(eventName: String, listener: Function): Agent.this.type

    Alias for emitter.on(eventName, listener).

    Alias for emitter.on(eventName, listener).

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.addListener(eventName, listener)

    See also

    on()

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. 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).

    Definition Classes
    Agent
    Example:

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

  8. 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.

    Definition Classes
    Agent
    Example:

    1. agent.destroy()

  9. val domain: Domain
    Definition Classes
    IEventEmitter
  10. def emit(name: String, args: Any*): Boolean

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    name

    the event name

    args

    the event arguments

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.emit(name[, arg1][, arg2][, ...])

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. 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.

    Definition Classes
    Agent
    Example:

    1. agent.freeSockets

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getMaxListeners(): Int

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.getMaxListeners()

    See also

    setMaxListeners()

  18. def getName(options: GetNameOptions): String
    Definition Classes
    Agent
  19. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  23. def keepSocketAlive(socket: Socket): Unit
    Definition Classes
    Agent
  24. def listenerCount(eventName: String): Int

    Returns the number of listeners listening to the event named eventName.

    Returns the number of listeners listening to the event named eventName.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listenerCount(eventName)

  25. def listeners(eventName: String): Array[Function]

    Returns a copy of the array of listeners for the event named eventName.

    Returns a copy of the array of listeners for the event named eventName.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listeners(eventName)

  26. 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.

    Definition Classes
    Agent
    Example:

    1. agent.maxFreeSockets

  27. 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.

    Definition Classes
    Agent
    Example:

    1. agent.maxSockets

  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def off(eventName: String, listner: Function): Agent.this.type
    Definition Classes
    IEventEmitter
  32. def on(eventName: String, listener: Function): Agent.this.type

    Adds the listener function to the end of the listeners array for the event named eventName.

    Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.on(eventName, listener)

  33. def once(eventName: String, listener: Function): Agent.this.type

    Adds a one time listener function for the event named eventName.

    Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.once(eventName, listener)

  34. def prependListener(eventName: String, listener: Function): Agent.this.type
    Definition Classes
    IEventEmitter
  35. def prependOnceListener(eventName: String, listener: Function): Agent.this.type
    Definition Classes
    IEventEmitter
  36. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  37. def rawListeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  38. def removeAllListeners(): Agent.this.type
    Definition Classes
    IEventEmitter
  39. def removeAllListeners(eventName: String): Agent.this.type

    Removes all listeners, or those of the specified eventName.

    Removes all listeners, or those of the specified eventName.

    Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeAllListeners([eventName])

  40. def removeListener(eventName: String, listener: Function): Agent.this.type

    Removes the specified listener from the listener array for the event named eventName.

    Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.

    Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeListener(eventName, listener)

  41. 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.

    Definition Classes
    Agent
    Example:

    1. agent.requests

  42. def reuseSocket(socket: Socket, request: ClientRequest): Unit
    Definition Classes
    Agent
  43. def setMaxListeners(n: Int): Agent.this.type

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) for to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.setMaxListeners(n)

  44. 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.

    Definition Classes
    Agent
    Example:

    1. agent.sockets

  45. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  46. def toLocaleString(): String
    Definition Classes
    Object
  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. def valueOf(): Any
    Definition Classes
    Object
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from http.Agent

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped