Package-level declarations

Types

sealed external interface AddressInfo

external class BlockList

The BlockList object can be used with some network APIs to specify rules for disabling inbound or outbound access to specific IP addresses, IP ranges, or IP subnets.

ConnectOpts

sealed external interface ConnectOpts

DropArgument

sealed external interface DropArgument

IpcNetConnectOpts

sealed external interface IpcNetConnectOpts : IpcSocketConnectOpts, SocketConstructorOpts

IpcSocketConnectOpts

sealed external interface IpcSocketConnectOpts : ConnectOpts

IPVersion

sealed external interface IPVersion

ListenOptions

sealed external interface ListenOptions : Abortable

LookupFunction

typealias LookupFunction = (hostname: String, options: LookupOptions, callback: (err: ErrnoException?, address: Any, family: Double?) -> Unit) -> Unit

NetConnectOpts

typealias NetConnectOpts = Any

OnReadOpts

sealed external interface OnReadOpts

Server

open external class Server : EventEmitter

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

ServerOpts

external interface ServerOpts

Socket

open external class Socket : Duplex

This class is an abstraction of a TCP socket or a streaming IPC endpoint (uses named pipes on Windows, and Unix domain sockets otherwise). It is also an EventEmitter.

SocketAddress

external class SocketAddress

SocketAddressInitOptions

sealed external interface SocketAddressInitOptions

SocketConnectOpts

typealias SocketConnectOpts = Any

SocketConstructorOpts

sealed external interface SocketConstructorOpts

SocketReadyState

sealed external interface SocketReadyState

TcpNetConnectOpts

sealed external interface TcpNetConnectOpts : TcpSocketConnectOpts, SocketConstructorOpts

TcpSocketConnectOpts

external interface TcpSocketConnectOpts : ConnectOpts

Functions

connect

external fun connect(options: NetConnectOpts, connectionListener: () -> Unit = definedExternally): Socket

Aliases to {@link createConnection}.

external fun connect(path: String, connectionListener: () -> Unit = definedExternally): Socket

external fun connect(port: Number, host: String = definedExternally, connectionListener: () -> Unit = definedExternally): Socket

createConnection

external fun createConnection(options: NetConnectOpts, connectionListener: () -> Unit = definedExternally): Socket

A factory function, which creates a new {@link Socket}, immediately initiates connection with socket.connect(), then returns the net.Socket that starts the connection.

external fun createConnection(path: String, connectionListener: () -> Unit = definedExternally): Socket

external fun createConnection(port: Number, host: String = definedExternally, connectionListener: () -> Unit = definedExternally): Socket

createServer

external fun createServer(): Server

external fun createServer(options: ServerOpts = definedExternally, connectionListener: (socket: Socket) -> Unit = definedExternally): Server

external fun createServer(connectionListener: (socket: Socket) -> Unit = definedExternally): Server

Creates a new TCP or IPC server.

getDefaultAutoSelectFamily

external fun getDefaultAutoSelectFamily(): Boolean

Gets the current default value of the autoSelectFamily option of socket.connect(options). The initial default value is true, unless the command line option--no-network-family-autoselection is provided.

getDefaultAutoSelectFamilyAttemptTimeout

external fun getDefaultAutoSelectFamilyAttemptTimeout(): Double

Gets the current default value of the autoSelectFamilyAttemptTimeout option of socket.connect(options). The initial default value is 250 or the value specified via the command line option --network-family-autoselection-attempt-timeout.

isIP

external fun isIP(input: String): Double

Returns 6 if input is an IPv6 address. Returns 4 if input is an IPv4 address in dot-decimal notation with no leading zeroes. Otherwise, returns0.

isIPv4

external fun isIPv4(input: String): Boolean

Returns true if input is an IPv4 address in dot-decimal notation with no leading zeroes. Otherwise, returns false.

isIPv6

external fun isIPv6(input: String): Boolean

Returns true if input is an IPv6 address. Otherwise, returns false.

setDefaultAutoSelectFamily

external fun setDefaultAutoSelectFamily(value: Boolean)

Sets the default value of the autoSelectFamily option of socket.connect(options).

setDefaultAutoSelectFamilyAttemptTimeout

external fun setDefaultAutoSelectFamilyAttemptTimeout(value: Number)

Sets the default value of the autoSelectFamilyAttemptTimeout option of socket.connect(options).