kotlin-node/node.http2/Http2Server

Http2Server

sealed external interface Http2Server<Http1Request : IncomingMessage, Http1Response : ServerResponse<*>, Http2Request : Http2ServerRequest, Http2Response : Http2ServerResponse<*>> : Server, HTTP2ServerCommon(source)

Properties

checkContinueEvent

abstract val checkContinueEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple2<Http2Request, Http2Response>>

closeEvent

open val closeEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple>

connectionEvent

open val connectionEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<node/net/Socket>>

connections

var connections: Double

dropEvent

val dropEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<node/net/DropArgument>>

errorEvent

open val errorEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<ERROR CLASS: Symbol not found for js.errors.JsError>>

listening

val listening: Boolean

Indicates whether or not the server is listening for connections.

listeningEvent

open val listeningEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple>

maxConnections

var maxConnections: Double

Set this property to reject connections when the server's connection count gets high.

requestEvent

abstract val requestEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple2<Http2Request, Http2Response>>

sessionErrorEvent

abstract val sessionErrorEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<ERROR CLASS: Symbol not found for js.errors.JsError>>

sessionEvent

abstract val sessionEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<node/http2/ServerHttp2Session<Http1Request, Http1Response, Http2Request, Http2Response>>>

streamEvent

abstract val streamEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple3<node/http2/ServerHttp2Stream, node/http2/IncomingHttpHeaders, kotlin/Double>>

timeoutEvent

abstract val timeoutEvent: EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple>

Functions

addListener

fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

abstract fun addListener(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

abstract override fun addListener(event: String, listener: Function<Unit>)

events.EventEmitter

address

fun address(): Any?

Returns the bound address, the address family name, and port of the server as reported by the operating system if listening on an IP socket (useful to find which port was assigned when getting an OS-assigned address):{ port: 12346, family: 'IPv4', address: '127.0.0.1' }.

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

Stops the server from accepting new connections and keeps existing connections. This function is asynchronous, the server is finally closed when all connections are ended and the server emits a 'close' event. The optional callback will be called once the 'close' event occurs. Unlike that event, it will be called with an Error as its only argument if the server was not open when it was closed.

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.

abstract override fun emit(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, vararg args: Any?): Boolean

abstract override fun emit(event: String, vararg args: Any?): Boolean

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.

getConnections

fun getConnections(cb: (@R|kotlin/ParameterName|(name = String(error)) ERROR CLASS: Symbol not found for js.errors.JsError??, count: Double) -> Unit)

Asynchronously get the number of concurrent connections on the server. Works when sockets were sent to forks.

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

listen

fun listen(handle: Any?, listeningListener: () -> Unit = definedExternally)

fun listen(port: Number = definedExternally, listeningListener: () -> Unit = definedExternally)

fun listen(path: String, listeningListener: () -> Unit = definedExternally)

fun listen(options: ListenOptions, listeningListener: () -> Unit = definedExternally)

fun listen(handle: Any?, backlog: Number = definedExternally, listeningListener: () -> Unit = definedExternally)

fun listen(port: Number = definedExternally, backlog: Number = definedExternally, listeningListener: () -> Unit = definedExternally)

fun listen(port: Number = definedExternally, hostname: String = definedExternally, listeningListener: () -> Unit = definedExternally)

fun listen(path: String, backlog: Number = definedExternally, listeningListener: () -> Unit = definedExternally)

fun listen(port: Number = definedExternally, hostname: String = definedExternally, backlog: Number = definedExternally, listeningListener: () -> Unit = definedExternally)

Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens 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.

abstract fun on(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

abstract override fun on(event: String, listener: Function<Unit>)

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.

abstract fun once(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

abstract override fun once(event: String, listener: Function<Unit>)

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.

abstract fun prependListener(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

abstract override fun prependListener(event: String, listener: Function<Unit>)

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.

abstract fun prependOnceListener(event: ERROR CLASS: Symbol not found for js.symbol.Symbol, listener: Function<Unit>)

abstract override fun prependOnceListener(event: String, listener: Function<Unit>)

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

ref

fun ref()

Opposite of unref(), calling ref() on a previously unrefed server will not let the program exit if it's the only server left (the default behavior). If the server is refed calling ref() again will have no effect.

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.

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.

setTimeout

abstract fun setTimeout(msec: Number = definedExternally, callback: () -> Unit = definedExternally)

unref

fun unref()

Calling unref() on a server will allow the program to exit if this is the only active server in the event system. If the server is already unrefed callingunref() again will have no effect.

updateSettings

abstract fun updateSettings(settings: Settings)

Throws ERR_HTTP2_INVALID_SETTING_VALUE for invalid settings values. Throws ERR_INVALID_ARG_TYPE for invalid settings argument.