Server

open external class Server : EventEmitter(source)

This class is used to create a TCP or IPC server.

Since

v0.1.90

Inheritors

Constructors

Link copied to clipboard
constructor(connectionListener: (socket: Socket) -> Unit = definedExternally)
constructor(options: ServerOpts = definedExternally, connectionListener: (socket: Socket) -> Unit = definedExternally)

Properties

Link copied to clipboard
open external val closeEvent: EventInstance<Tuple>
Link copied to clipboard
Link copied to clipboard
external var connections: Double
Link copied to clipboard
Link copied to clipboard
open external val errorEvent: EventInstance<Tuple1<JsError>>
Link copied to clipboard
external val listening: Boolean

Indicates whether or not the server is listening for connections.

Link copied to clipboard
open external val listeningEvent: EventInstance<Tuple>
Link copied to clipboard
external var maxConnections: Double

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

Functions

Link copied to clipboard
external fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

open external fun addListener(event: String, listener: Function<Unit>)

events.EventEmitter

Link copied to clipboard
external 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' }.

Link copied to clipboard
external fun close(callback: (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.

Link copied to clipboard
external 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.

open external fun emit(event: Symbol, vararg args: Any?): Boolean
open external fun emit(event: String, vararg args: Any?): Boolean
Link copied to clipboard

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

Link copied to clipboard
external fun getConnections(cb: (JsError?, count: Double) -> Unit)

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

Link copied to clipboard
external 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}.

Link copied to clipboard
external fun listen(handle: Any?, listeningListener: () -> Unit = definedExternally)
external fun listen(port: Number = definedExternally, listeningListener: () -> Unit = definedExternally)
external fun listen(path: String, listeningListener: () -> Unit = definedExternally)
external fun listen(options: ListenOptions, listeningListener: () -> Unit = definedExternally)
external fun listen(handle: Any?, backlog: Number = definedExternally, listeningListener: () -> Unit = definedExternally)
external fun listen(port: Number = definedExternally, backlog: Number = definedExternally, listeningListener: () -> Unit = definedExternally)
external fun listen(port: Number = definedExternally, hostname: String = definedExternally, listeningListener: () -> Unit = definedExternally)
external fun listen(path: String, backlog: Number = definedExternally, listeningListener: () -> Unit = definedExternally)

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

Link copied to clipboard
external 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.

Link copied to clipboard

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

Link copied to clipboard
external fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

Link copied to clipboard
external 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.

open external fun on(event: String, listener: Function<Unit>)
Link copied to clipboard
external 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.

open external fun once(event: String, listener: Function<Unit>)
Link copied to clipboard
external 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.

open external fun prependListener(event: String, listener: Function<Unit>)
Link copied to clipboard
external 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.

open external fun prependOnceListener(event: String, listener: Function<Unit>)
Link copied to clipboard

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

Link copied to clipboard
external 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.

Link copied to clipboard
external fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

Link copied to clipboard
external fun removeListener(type: EventType, listener: EventListener)

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

Link copied to clipboard
external 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.

Link copied to clipboard
external 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.