Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UDPAdapter

Hierarchy

  • EventEmitter
    • UDPAdapter

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns UDPAdapter

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

_bindEvents

  • _bindEvents(): void

  • Returns void

addListener

  • addListener<K>(event: K, listener: UDPEvents[K]): this

addMembership

  • addMembership(multicastAddress: string, multicastInterface?: string): Promise<void>

  • 加入多播组

    Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns Promise<void>

bind

  • bind(port?: number, address?: string): Promise<AddressInfo>

  • 对于 UDP 套接字，使 Socket 在命名的 port 和可选的 address 上监听数据报消息。 如果未指定 port 或 0，则操作系统将尝试绑定到随机端口。如果未指定 address，则操作系统将尝试监听所有地址。 一旦绑定完成，则会触发 'listening' 事件

    Parameters

    • Optional port: number
    • Optional address: string

    Returns Promise<AddressInfo>

close

  • close(): Promise<void>

  • 关闭底层套接字并停止监听其上的数据。 如果提供回调，则将其添加为 'close' 事件的监听器。

    Returns Promise<void>

connect

  • connect(port: number, address?: string): Promise<void>

  • 关联远程地址和端口。关联后，发送数据无需指定端口和地址。

    Parameters

    • port: number
    • Optional address: string

    Returns Promise<void>

createSocket

dropMembership

  • dropMembership(multicastAddress: string, multicastInterface?: string): Promise<void>

  • 退出多播组

    Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns Promise<void>

emit

  • emit<K>(event: K, ...args: Parameters<UDPEvents[K]>): boolean

  • Type parameters

    Parameters

    • event: K
    • Rest ...args: Parameters<UDPEvents[K]>

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getLocalAddress

  • 返回包含套接字地址信息的对象。 对于 UDP 套接字，此对象将包含 address、family 和 port 属性。如果在未绑定的套接字上调用此方法将抛出 EBADF。

    Returns Promise<AddressInfo>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getRemoteAddress

  • 返回包含远程端点的 address、family 和 port 的对象。如果未连接，抛出 ERR_SOCKET_DGRAM_NOT_CONNECTED 异常

    Returns Promise<AddressInfo>

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): UDPAdapter

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns UDPAdapter

on

  • on<K>(event: K, listener: UDPEvents[K]): this

  • Type parameters

    Parameters

    Returns this

once

  • once<K>(event: K, listener: UDPEvents[K]): this

  • Type parameters

    Parameters

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): UDPAdapter

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns UDPAdapter

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): UDPAdapter

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns UDPAdapter

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): UDPAdapter

  • Parameters

    • Optional event: string | symbol

    Returns UDPAdapter

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): UDPAdapter

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns UDPAdapter

send

  • 在套接字上广播数据报。对于无连接套接字，则必须指定目标 port 和 address。另一方面，已连接的套接字将使用其关联的远程端点，因此不得设置 port 和 address 参数。

    Parameters

    Returns Promise<number>

setBroadcast

  • setBroadcast(flag: boolean): Promise<void>

  • 设置是否广播

    Parameters

    • flag: boolean

    Returns Promise<void>

setMaxListeners

  • Parameters

    • n: number

    Returns UDPAdapter

setMulticastInterface

  • setMulticastInterface(multicastInterface: string): Promise<void>

  • 设置广播/多播接口，网卡

    Parameters

    • multicastInterface: string

    Returns Promise<void>

setMulticastLoopback

  • setMulticastLoopback(flag: boolean): Promise<void>

  • 设置或清除 IP_MULTICAST_LOOP 套接字选项。 当设置为 true 时，本地接口也会收到多播数据包。如果在未绑定的套接字上调用此方法将抛出 EBADF。

    Parameters

    • flag: boolean

    Returns Promise<void>

setMulticastTTL

  • setMulticastTTL(ttl: number): Promise<void>

  • 设置 IP_MULTICAST_TTL socket参数(TTL for Time to Live)。

    Parameters

    • ttl: number

    Returns Promise<void>

setRecvBufferSize

  • setRecvBufferSize(size: number): Promise<void>

  • 设置 SO_RCVBUF 套接字选项。设置最大套接字接收缓冲区（以字节为单位）。 如果在未绑定的套接字上调用此方法将抛出 ERR_SOCKET_BUFFER_SIZE。

    Parameters

    • size: number

    Returns Promise<void>

setSendBufferSize

  • setSendBufferSize(size: number): Promise<void>

  • 设置 SO_SNDBUF 套接字选项。设置最大套接字发送缓冲区（以字节为单位）。

    Parameters

    • size: number

    Returns Promise<void>

setTTL

  • setTTL(ttl: number): Promise<void>

  • 设置 IP_TTL socket参数。如果socket未绑定地址，会抛出 EBADF 异常

    Parameters

    • ttl: number

    Returns Promise<void>

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc