A Http2ServerRequest object is created by {@link Server} or {@link SecureServer} and passed as the first argument to the 'request' event. It may be used to access a request status, headers, and data.

Http2ServerResponse

external class Http2ServerResponse : Writable

This object is created internally by an HTTP server, not by the user. It is passed as the second parameter to the 'request' event.

Http2Session

sealed external interface Http2Session : EventEmitter

Http2Stream

sealed external interface Http2Stream : Duplex

IncomingHttpHeaders

sealed external interface IncomingHttpHeaders : IncomingHttpHeaders

IncomingHttpStatusHeader

sealed external interface IncomingHttpStatusHeader

SecureClientSessionOptions

sealed external interface SecureClientSessionOptions : ClientSessionOptions, ConnectionOptions

SecureServerOptions

sealed external interface SecureServerOptions : SecureServerSessionOptions

SecureServerSessionOptions

sealed external interface SecureServerSessionOptions : ServerSessionOptions, TlsOptions

ServerHttp2Session

sealed external interface ServerHttp2Session : Http2Session

ServerHttp2Stream

sealed external interface ServerHttp2Stream : Http2Stream

ServerOptions

sealed external interface ServerOptions : ServerSessionOptions

ServerSessionOptions

sealed external interface ServerSessionOptions : SessionOptions

ServerStreamFileResponseOptions

sealed external interface ServerStreamFileResponseOptions

ServerStreamFileResponseOptionsWithError

sealed external interface ServerStreamFileResponseOptionsWithError : ServerStreamFileResponseOptions

ServerStreamResponseOptions

sealed external interface ServerStreamResponseOptions

SessionOptions

sealed external interface SessionOptions

SessionState

sealed external interface SessionState

Settings

sealed external interface Settings

StatOptions

sealed external interface StatOptions

StreamPriorityOptions

sealed external interface StreamPriorityOptions

StreamState

sealed external interface StreamState

Properties

sensitiveHeaders

external val sensitiveHeaders: Symbol

This symbol can be set as a property on the HTTP/2 headers object with an array value in order to provide a list of headers considered sensitive.

Functions

connect

external fun connect(authority: String): ClientHttp2Session

external fun connect(authority: URL): ClientHttp2Session

external fun connect(authority: String, options: ClientSessionOptions = definedExternally, listener: (session: ClientHttp2Session, socket: Any) -> Unit = definedExternally): ClientHttp2Session

external fun connect(authority: String, options: SecureClientSessionOptions = definedExternally, listener: (session: ClientHttp2Session, socket: Any) -> Unit = definedExternally): ClientHttp2Session

external fun connect(authority: URL, options: ClientSessionOptions = definedExternally, listener: (session: ClientHttp2Session, socket: Any) -> Unit = definedExternally): ClientHttp2Session

external fun connect(authority: URL, options: SecureClientSessionOptions = definedExternally, listener: (session: ClientHttp2Session, socket: Any) -> Unit = definedExternally): ClientHttp2Session

external fun connect(authority: String, listener: (session: ClientHttp2Session, socket: Any) -> Unit): ClientHttp2Session

external fun connect(authority: URL, listener: (session: ClientHttp2Session, socket: Any) -> Unit): ClientHttp2Session

Returns a ClientHttp2Session instance.

createSecureServer

external fun createSecureServer(onRequestHandler: (request: Http2ServerRequest, response: Http2ServerResponse) -> Unit = definedExternally): Http2SecureServer

Returns a tls.Server instance that creates and manages Http2Session instances.

external fun createSecureServer(options: SecureServerOptions, onRequestHandler: (request: Http2ServerRequest, response: Http2ServerResponse) -> Unit = definedExternally): Http2SecureServer

createServer

external fun createServer(onRequestHandler: (request: Http2ServerRequest, response: Http2ServerResponse) -> Unit = definedExternally): Http2Server

Returns a net.Server instance that creates and manages Http2Session instances.

external fun createServer(options: ServerOptions, onRequestHandler: (request: Http2ServerRequest, response: Http2ServerResponse) -> Unit = definedExternally): Http2Server

getDefaultSettings

external fun getDefaultSettings(): Settings

Returns an object containing the default settings for an Http2Session instance. This method returns a new object instance every time it is called so instances returned may be safely modified for use.

getPackedSettings

external fun getPackedSettings(settings: Settings): Buffer

Returns a Buffer instance containing serialized representation of the given HTTP/2 settings as specified in the HTTP/2 specification. This is intended for use with the HTTP2-Settings header field.

getUnpackedSettings

external fun getUnpackedSettings(buf: Uint8Array<*>): Settings

Returns a HTTP/2 Settings Object containing the deserialized settings from the given Buffer as generated by http2.getPackedSettings().

performServerHandshake

external fun performServerHandshake(socket: Duplex, options: ServerOptions = definedExternally): ServerHttp2Session

Create an HTTP/2 server session from an existing socket.