DatagramSocket | @vertx/core

A datagram socket can be used to send DatagramPacket's to remote datagram servers and receive DatagramPackets .

Usually you use a datagram socket to send UDP over the wire. UDP is connection-less which means you are not connected to the remote peer in a persistent way. Because of this you have to supply the address and port of the remote peer when sending data.

You can send data to ipv4 or ipv6 addresses, which also include multicast addresses.

Please consult the documentation for more information on datagram sockets.

Hierarchy

DatagramSocket

Implements

Index

Methods

blockMulticastGroup

blockMulticastGroup(multicastAddress: string, sourceToBlock: string): PromiseLike<void>
blockMulticastGroup(multicastAddress: string, sourceToBlock: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket
blockMulticastGroup(multicastAddress: string, networkInterface: string, sourceToBlock: string): PromiseLike<void>
blockMulticastGroup(multicastAddress: string, networkInterface: string, sourceToBlock: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1865
Block the given address for the given multicast address and notifies the once the operation completes.

Parameters
- multicastAddress: string
- sourceToBlock: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1871
Block the given address for the given multicast address and notifies the once the operation completes.

Parameters
- multicastAddress: string
- sourceToBlock: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1877
Block the given address for the given multicast address on the given network interface and notifies the once the operation completes.

Parameters
- multicastAddress: string
- networkInterface: string
- sourceToBlock: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1883
Block the given address for the given multicast address on the given network interface and notifies the once the operation completes.

Parameters
- multicastAddress: string
- networkInterface: string
- sourceToBlock: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket

close

close(): PromiseLike<void>
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1799
Closes the DatagramSocket implementation asynchronous and notifies the handler once done.

Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1805
Closes the DatagramSocket implementation asynchronous and notifies the handler once done.

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

endHandler

endHandler(endHandler: ((res: void) => void) | Handler<void> | null | undefined): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1909
Parameters
- endHandler: ((res: void) => void) | Handler<void> | null | undefined
Returns DatagramSocket

exceptionHandler

exceptionHandler(handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1913
Parameters
- handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined
Returns DatagramSocket

fetch

fetch(amount: number): DatagramSocket

Implementation of ReadStream.fetch
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1905
Parameters
- amount: number
Returns DatagramSocket

handler

handler(handler: ((res: DatagramPacket) => void) | Handler<DatagramPacket> | null | undefined): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1911
Parameters
- handler: ((res: DatagramPacket) => void) | Handler<DatagramPacket> | null | undefined
Returns DatagramSocket

isMetricsEnabled

isMetricsEnabled(): boolean

Implementation of Measured.isMetricsEnabled
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1724
Whether the metrics are enabled for this measured object

Returns boolean

listen

listen(port: number, host: string): PromiseLike<DatagramSocket>
listen(port: number, host: string, handler: ((res: AsyncResult<DatagramSocket>) => void) | Handler<AsyncResult<DatagramSocket>>): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1888
Start listening on the given port and host. The handler will be called when the socket is listening.

Parameters
- port: number
- host: string
Returns PromiseLike<DatagramSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1893
Start listening on the given port and host. The handler will be called when the socket is listening.

Parameters
- port: number
- host: string
- handler: ((res: AsyncResult<DatagramSocket>) => void) | Handler<AsyncResult<DatagramSocket>>
Returns DatagramSocket

listenMulticastGroup

listenMulticastGroup(multicastAddress: string): PromiseLike<void>
listenMulticastGroup(multicastAddress: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket
listenMulticastGroup(multicastAddress: string, networkInterface: string, source: string | null | undefined): PromiseLike<void>
listenMulticastGroup(multicastAddress: string, networkInterface: string, source: string | null | undefined, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1817
Joins a multicast group and listens for packets send to it. The is notified once the operation completes.

Parameters
- multicastAddress: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1823
Joins a multicast group and listens for packets send to it. The is notified once the operation completes.

Parameters
- multicastAddress: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1829
Joins a multicast group and listens for packets send to it on the given network interface. The is notified once the operation completes.

Parameters
- multicastAddress: string
- networkInterface: string
- source: string | null | undefined
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1835
Joins a multicast group and listens for packets send to it on the given network interface. The is notified once the operation completes.

Parameters
- multicastAddress: string
- networkInterface: string
- source: string | null | undefined
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket

localAddress

localAddress(): SocketAddress

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1811
Return the SocketAddress to which this DatagramSocket is bound.

Returns SocketAddress

pause

pause(): DatagramSocket

Implementation of ReadStream.pause
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1897
Returns DatagramSocket

pipe

pipe(): Pipe<DatagramPacket>

Implementation of ReadStream.pipe
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1731
Pause this stream and return a to transfer the elements of this stream to a destination .

The stream will be resumed when the pipe will be wired to a WriteStream.

Returns Pipe<DatagramPacket>

pipeTo

pipeTo(dst: WriteStream<DatagramPacket>): PromiseLike<void>
pipeTo(dst: WriteStream<DatagramPacket>, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

Implementation of ReadStream.pipeTo
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1741
Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters
- dst: WriteStream<DatagramPacket>
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1751
Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters
- dst: WriteStream<DatagramPacket>
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

resume

resume(): DatagramSocket

Implementation of ReadStream.resume
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1901
Returns DatagramSocket

send

send(packet: Buffer, port: number, host: string): PromiseLike<void>
send(packet: Buffer, port: number, host: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket
send(str: string, port: number, host: string): PromiseLike<void>
send(str: string, port: number, host: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket
send(str: string, enc: string, port: number, host: string): PromiseLike<void>
send(str: string, enc: string, port: number, host: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1757
Write the given Buffer to the SocketAddress. The Handler will be notified once the write completes.

Parameters
- packet: Buffer
- port: number
- host: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1763
Write the given Buffer to the SocketAddress. The Handler will be notified once the write completes.

Parameters
- packet: Buffer
- port: number
- host: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1775
Write the given String to the SocketAddress using UTF8 encoding. The will be notified once the write completes.

Parameters
- str: string
- port: number
- host: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1781
Write the given String to the SocketAddress using UTF8 encoding. The will be notified once the write completes.

Parameters
- str: string
- port: number
- host: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1787
Write the given String to the SocketAddress using the given encoding. The will be notified once the write completes.

Parameters
- str: string
- enc: string
- port: number
- host: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1793
Write the given String to the SocketAddress using the given encoding. The will be notified once the write completes.

Parameters
- str: string
- enc: string
- port: number
- host: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket

sender

sender(port: number, host: string): WriteStream<Buffer>

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1769
Returns a WriteStream able to send to the SocketAddress.

Parameters
- port: number
- host: string
Returns WriteStream<Buffer>

unlistenMulticastGroup

unlistenMulticastGroup(multicastAddress: string): PromiseLike<void>
unlistenMulticastGroup(multicastAddress: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket
unlistenMulticastGroup(multicastAddress: string, networkInterface: string, source: string | null | undefined): PromiseLike<void>
unlistenMulticastGroup(multicastAddress: string, networkInterface: string, source: string | null | undefined, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): DatagramSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1841
Leaves a multicast group and stops listening for packets send to it. The is notified once the operation completes.

Parameters
- multicastAddress: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1847
Leaves a multicast group and stops listening for packets send to it. The is notified once the operation completes.

Parameters
- multicastAddress: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1853
Leaves a multicast group and stops listening for packets send to it on the given network interface. The is notified once the operation completes.

Parameters
- multicastAddress: string
- networkInterface: string
- source: string | null | undefined
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:1859
Leaves a multicast group and stops listening for packets send to it on the given network interface. The is notified once the operation completes.

Parameters
- multicastAddress: string
- networkInterface: string
- source: string | null | undefined
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns DatagramSocket

Hierarchy

Implements

Index

Methods

Methods

blockMulticastGroup

Parameters

multicastAddress: string

sourceToBlock: string

Returns PromiseLike<void>

Parameters

multicastAddress: string

sourceToBlock: string

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns DatagramSocket

Parameters

multicastAddress: string

networkInterface: string

sourceToBlock: string

Returns PromiseLike<void>

Parameters

multicastAddress: string

networkInterface: string

sourceToBlock: string

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns DatagramSocket

close

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

endHandler

Parameters

endHandler: ((res: void) => void) | Handler<void> | null | undefined

Returns DatagramSocket

exceptionHandler

Parameters

handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined

Returns DatagramSocket

fetch

Parameters

amount: number

Returns DatagramSocket

handler

Parameters

handler: ((res: DatagramPacket) => void) | Handler<DatagramPacket> | null | undefined

Returns DatagramSocket

isMetricsEnabled

Returns boolean

listen

Parameters

port: number

host: string

Returns PromiseLike<DatagramSocket>

Parameters

port: number

host: string

handler: ((res: AsyncResult<DatagramSocket>) => void) | Handler<AsyncResult<DatagramSocket>>

Returns DatagramSocket

listenMulticastGroup

Parameters

multicastAddress: string

Returns PromiseLike<void>

Parameters

multicastAddress: string

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns DatagramSocket

Parameters

multicastAddress: string

networkInterface: string

source: string | null | undefined

Returns PromiseLike<void>

Parameters

multicastAddress: string

networkInterface: string

source: string | null | undefined

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns DatagramSocket

localAddress

Returns SocketAddress