http2.ClientSessionOptions

interface ClientSessionOptions

• createConnection?: (authority: URL, option: SessionOptions) => Duplex

  An optional callback that receives the URL instance passed to connect and the options object, and returns any Duplex stream that is to be used as the connection for this session.

• maxDeflateDynamicTableSize?: number

  Sets the maximum dynamic table size for deflating header fields.

• maxHeaderListPairs?: number

  Sets the maximum number of header entries. This is similar to server.maxHeadersCount or request.maxHeadersCount in the node:http module. The minimum value is 1.

• maxOutstandingPings?: number

  Sets the maximum number of outstanding, unacknowledged pings.

• maxReservedRemoteStreams?: number

  Sets the maximum number of reserved push streams the client will accept at any given time. Once the current number of currently reserved push streams exceeds reaches this limit, new push streams sent by the server will be automatically rejected. The minimum allowed value is 0. The maximum allowed value is 2³²-1. A negative value sets this option to the maximum allowed value.

• maxSendHeaderBlockLength?: number

  Sets the maximum allowed size for a serialized, compressed block of headers. Attempts to send headers that exceed this limit will result in a 'frameError' event being emitted and the stream being closed and destroyed.

• maxSessionMemory?: number

  Sets the maximum memory that the Http2Session is permitted to use. The value is expressed in terms of number of megabytes, e.g. 1 equal 1 megabyte. The minimum value allowed is 1. This is a credit based limit, existing Http2Streams may cause this limit to be exceeded, but new Http2Stream instances will be rejected while this limit is exceeded. The current number of Http2Stream sessions, the current memory use of the header compression tables, current data queued to be sent, and unacknowledged PING and SETTINGS frames are all counted towards the current limit.

• maxSettings?: number

  Sets the maximum number of settings entries per SETTINGS frame. The minimum value allowed is 1.

• paddingStrategy?: number

  Strategy used for determining the amount of padding to use for HEADERS and DATA frames.

• peerMaxConcurrentStreams?: number

  Sets the maximum number of concurrent streams for the remote peer as if a SETTINGS frame had been received. Will be overridden if the remote peer sets its own value for maxConcurrentStreams.

• protocol?: 'http:' | 'https:'

  The protocol to connect with, if not set in the authority. Value may be either 'http:' or 'https:'.

• remoteCustomSettings?: number[]

  The array of integer values determines the settings types, which are included in the CustomSettings-property of the received remoteSettings. Please see the CustomSettings-property of the Http2Settings object for more information, on the allowed setting types.

• settings?: Settings

  The initial settings to send to the remote peer upon connection.

• unknownProtocolTimeout?: number

  Specifies a timeout in milliseconds that a server should wait when an ['unknownProtocol'][] is emitted. If the socket has not been destroyed by that time the server will destroy it.