Class Udp

UDP handles encapsulate UDP communication for both clients and servers.

Wrapper for uv_udp_t. See http://docs.libuv.org/en/v1.x/udp.html

Hierarchy

Handle
- Udp

Index

Constructors

constructor

Constructors

constructor

new Udp(): Udp

- Defined in uv/index.d.ts:285
Create and initialize a new wrapped uv_udp_t handle.

Returns Udp

Methods

bind

bind(host: string, port: number, flags: number): void

- Defined in uv/index.d.ts:295
Bind the UDP handle to an IP address and port.

Parameters
- host: string
- port: number
- flags: number
Returns void

close

close(onClose?: () => void): void

Inherited from Handle.close
- Defined in uv/index.d.ts:73
Request handle to be closed.

Wrapper for uv_close.

Parameters
- Optional onClose: () => void
  - - (): void
    - Returns void
Returns void

connect

connect(host: string, port: number): void

- Defined in uv/index.d.ts:301
Associate the UDP handle to a remote address and port, so every message sent by this handle is automatically sent to that destination.

Parameters
- host: string
- port: number
Returns void

getPeername

getPeername(): Address

- Defined in uv/index.d.ts:304
Get the remote IP and port of the UDP handle on connected UDP handles

Returns Address

getSendQueueCount

getSendQueueCount(): number

- Defined in uv/index.d.ts:360
Returns number

getSendQueueSize

getSendQueueSize(): number

- Defined in uv/index.d.ts:359
Returns number

getSockname

getSockname(): Address

- Defined in uv/index.d.ts:307
Get the local IP and port of the UDP handle.

Returns Address

hasRef

hasRef(): boolean

Inherited from Handle.hasRef
- Defined in uv/index.d.ts:94
Returns true if the handle referenced, false otherwise.

Wrapper for uv_has_ref.

Returns boolean

open

open(sock: number): void

- Defined in uv/index.d.ts:292
Opens an existing file descriptor or Windows SOCKET as a UDP handle.

Parameters
- sock: number
Returns void

recvStart

recvStart(onRecv: (error: Error, data: ArrayBuffer, address: Address, flags: number) => void): void

- Defined in uv/index.d.ts:354
Prepare for receiving data.

If the socket has not previously been bound with Udp.bind it will be bound to 0.0.0.0 and a random port number.

Parameters
- onRecv: (error: Error, data: ArrayBuffer, address: Address, flags: number) => void
  - - (error: Error, data: ArrayBuffer, address: Address, flags: number): void
    - Parameters
      - error: Error
      - data: ArrayBuffer
      - address: Address
      - flags: number
      Returns void
Returns void

recvStop

recvStop(): void

- Defined in uv/index.d.ts:357
Stop listening for incoming datagrams.

Returns void

ref

ref(): void

Inherited from Handle.ref
- Defined in uv/index.d.ts:80
Reference the handle.

Wrapper for uv_ref.

Returns void

send

send(req: UdpSend, buffer: ArrayBufferView | ArrayBuffer, host: string, port: number, onSend: (error: Error) => void): UdpSend
send(req: UdpSend, buffer: ArrayBufferView | ArrayBuffer, onSend: (error: Error) => void): UdpSend

- Defined in uv/index.d.ts:336
Send data over the UDP socket.

If the socket has not previously been bound with Udp.bind it will be bound to 0.0.0.0 and a random port number.

Parameters
- req: UdpSend
- buffer: ArrayBufferView | ArrayBuffer
- host: string
- port: number
- onSend: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns UdpSend
- Defined in uv/index.d.ts:338
Omit host and port for connected UDP handles.

Parameters
- req: UdpSend
- buffer: ArrayBufferView | ArrayBuffer
- onSend: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns UdpSend

setBroadcast

setBroadcast(on: number): void

- Defined in uv/index.d.ts:325
Set broadcast on or off.

Parameters
- on: number
Returns void

setMembership

setMembership(multicastAddress: string, interfaceAddress: string, membership: number): void

- Defined in uv/index.d.ts:310
Set membership for a multicast address

Parameters
- multicastAddress: string
- interfaceAddress: string
- membership: number
Returns void

setMulticastInterface

setMulticastInterface(interfaceAddress: string): void

- Defined in uv/index.d.ts:322
Set the multicast interface to send or receive data on.

Parameters
- interfaceAddress: string
Returns void

setMulticastLoop

setMulticastLoop(on: number): void

- Defined in uv/index.d.ts:316
Set IP multicast loop flag. Makes multicast packets loop back to local sockets.

Parameters
- on: number
Returns void

setMulticastTtl

setMulticastTtl(ttl: number): void

- Defined in uv/index.d.ts:319
Set the multicast ttl.

Parameters
- ttl: number
Returns void

setTtl

setTtl(ttl: number): void

- Defined in uv/index.d.ts:328
Set the time to live.

Parameters
- ttl: number
Returns void

trySend

trySend(buffer: ArrayBufferView | ArrayBuffer, host: string, port: number): number
trySend(buffer: ArrayBufferView | ArrayBuffer): number

- Defined in uv/index.d.ts:344
Same as Udp.send, but won’t queue a send request if it can’t be completed immediately.

Parameters
- buffer: ArrayBufferView | ArrayBuffer
- host: string
- port: number
Returns number
- Defined in uv/index.d.ts:346
Omit host and port for connected UDP handles.

Parameters
- buffer: ArrayBufferView | ArrayBuffer
Returns number

unref

unref(): void

Inherited from Handle.unref
- Defined in uv/index.d.ts:87
Un-reference the handle.

Wrapper for uv_unref.

Returns void

Generated using TypeDoc