View source

class Agent

package js.node.https

extends Agent

@:jsRequire("https","Agent")

An Agent object for HTTPS similar to http.Agent. See https.request for more information.

Constructor

new(?options:Null<HttpsAgentOptions>)

Inherited Variables

Defined by Agent

read onlyfreeSockets:DynamicAccess<Array<Socket>>

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

maxFreeSockets:Float

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:Float

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

read onlyrequests:DynamicAccess<Array<ClientRequest>>

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

read onlysockets:DynamicAccess<Array<Socket>>

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

Inherited Methods

Defined by Agent

createConnection(options:SocketConnectOptionsTcp, ?callback:(err:Error, stream:Socket) ‑> Void):Socket

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

destroy():Void

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

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

getName(options:HttpRequestOptions):String

Get a unique name for a set of request options, to determine whether a connection can be reused. For an HTTP agent, this returns host: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.

keepSocketAlive(socket:Socket):Void

Called when socket is detached from a request and could be persisted by the Agent.

This method can be overridden by a particular Agent subclass. If this method returns a falsy value, the socket will be destroyed instead of persisting it for use with the next request.

reuseSocket(socket:Socket, request:ClientRequest):Void

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

This method can be overridden by a particular Agent subclass.