Socket

sealed external interface Socket : ReadWriteStream(source)

Properties

Link copied to clipboard
abstract var isTTY: Boolean?
Link copied to clipboard
abstract var readable: Boolean
Link copied to clipboard
abstract var writable: Boolean

Functions

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

Alias for emitter.on(eventName, listener).

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

Link copied to clipboard
abstract fun end(cb: () -> Unit = definedExternally)
abstract fun end(data: Uint8Array<*>, cb: () -> Unit = definedExternally)
abstract fun end(data: String, cb: () -> Unit = definedExternally)
abstract fun end(str: String, encoding: BufferEncoding = definedExternally, cb: () -> Unit = definedExternally)
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

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

Link copied to clipboard
abstract fun isPaused(): Boolean
Link copied to clipboard
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
fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

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

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

Link copied to clipboard
abstract fun pause()
Link copied to clipboard
abstract fun <T : WritableStream> pipe(destination: T, options: ReadableStreamPipeOptions = definedExternally): T
Link copied to clipboard

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.

Link copied to clipboard

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.

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
abstract fun read(size: Number = definedExternally): Any
Link copied to clipboard
fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

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

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

Link copied to clipboard
abstract fun resume()
Link copied to clipboard
abstract fun setEncoding(encoding: BufferEncoding)
Link copied to clipboard

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
abstract fun unpipe(destination: WritableStream = definedExternally)
Link copied to clipboard
abstract fun unshift(chunk: Uint8Array<*>, encoding: BufferEncoding = definedExternally)
abstract fun unshift(chunk: String, encoding: BufferEncoding = definedExternally)
Link copied to clipboard
abstract fun wrap(stream: ReadableStream)
Link copied to clipboard
abstract fun write(buffer: Uint8Array<*>, cb: (JsError?) -> Unit = definedExternally): Boolean
abstract fun write(buffer: String, cb: (JsError?) -> Unit = definedExternally): Boolean
abstract fun write(str: String, encoding: BufferEncoding = definedExternally, cb: (JsError?) -> Unit = definedExternally): Boolean