kotlin-node/node.dgram

Package-level declarations

Types

sealed external interface BindOptions

sealed external interface RemoteInfo

RemoteInfoFamily

sealed external interface RemoteInfoFamily

external class Socket : EventEmitter

Encapsulates the datagram functionality.

sealed external interface SocketOptions : Abortable

sealed external interface SocketType

Functions

external fun createSocket(options: SocketOptions, callback: (msg: Buffer, rinfo: RemoteInfo) -> Unit = definedExternally): Socket

external fun createSocket(type: SocketType, callback: (msg: Buffer, rinfo: RemoteInfo) -> Unit = definedExternally): Socket

Creates a dgram.Socket object. Once the socket is created, calling socket.bind() will instruct the socket to begin listening for datagram messages. When address and port are not passed to socket.bind() the method will bind the socket to the "all interfaces" address on a random port (it does the right thing for both udp4 and udp6 sockets). The bound address and port can be retrieved using socket.address().address and socket.address().port.