kotlin-node/node.https/Agent

Agent

external class Agent : Agent(source)

An Agent object for HTTPS similar to http.Agent. See {@link request} for more information.

Since

v0.4.5

Constructors

Agent

constructor(options: AgentOptions = definedExternally)

Properties

freeSockets

val freeSockets: {node/ReadOnlyDict<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<node/net/Socket>>=} ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, ERROR CLASS: Symbol not found for js.array.ReadonlyArray<node/net/Socket>>

An object which contains arrays of sockets currently awaiting use by the agent when keepAlive is enabled. Do not modify.

maxFreeSockets

var maxFreeSockets: Double

By default set to 256. For agents with keepAlive enabled, this sets the maximum number of sockets that will be left open in the free state.

maxSockets

var maxSockets: Double

By default set to Infinity. Determines how many concurrent sockets the agent can have open per origin. Origin is the returned value of agent.getName().

maxTotalSockets

var maxTotalSockets: Double

By default set to Infinity. Determines how many concurrent sockets the agent can have open. Unlike maxSockets, this parameter applies across all origins.

options

var options: AgentOptions

requests

val requests: {node/ReadOnlyDict<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<node/http/IncomingMessage>>=} ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, ERROR CLASS: Symbol not found for js.array.ReadonlyArray<node/http/IncomingMessage>>

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

sockets

val sockets: {node/ReadOnlyDict<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<node/net/Socket>>=} ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, ERROR CLASS: Symbol not found for js.array.ReadonlyArray<node/net/Socket>>

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

Functions

addListener

fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

createConnection

fun createConnection(options: ClientRequestArgs, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, stream: Duplex) -> Unit = definedExternally): Duplex?

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

fun createConnection(options: RequestOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, stream: Duplex) -> Unit = definedExternally): Duplex?

destroy

fun destroy()

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

emit

fun emit(type: EventType, vararg 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.

eventNames

fun eventNames(): Array<EventType>

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

getMaxListeners

fun getMaxListeners(): Double

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

getName

fun getName(options: ClientRequestArgs = definedExternally): String

Get a unique name for a set of request options, to determine whether a connection can be reused. For an HTTP agent, this returnshost:port:localAddress or host:port:localAddress:family. For an HTTPS agent, the name includes the CA, cert, ciphers, and other HTTPS/TLS-specific options that determine socket reusability.

fun getName(options: RequestOptions = definedExternally): String

keepSocketAlive

fun keepSocketAlive(socket: Duplex)

Called when socket is detached from a request and could be persisted by theAgent. Default behavior is to:

listenerCount

fun listenerCount(type: EventType, listener: EventListener = definedExternally): Double

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

listeners

fun listeners(type: EventType): Array<EventListener>

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

off

fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

fun on(type: EventType, listener: EventListener)

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.

once

fun once(type: EventType, listener: EventListener)

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

prependListener

fun prependListener(type: EventType, listener: EventListener)

Adds the listener function to the beginning 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.

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

rawListeners

fun rawListeners(type: EventType): Array<EventListener>

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

removeAllListeners

fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

removeListener

fun removeListener(type: EventType, listener: EventListener)

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

reuseSocket

fun reuseSocket(socket: Duplex, request: ClientRequest)

Called when socket is attached to request after being persisted because of the keep-alive options. Default behavior is to:

setMaxListeners

fun setMaxListeners(n: Number)

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. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.