Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UDPDeviceConnection

UDP连接器，基于UDP进行连接、数据通信

Hierarchy

  • UDPDeviceConnection

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

connectStatus

connectStatus: EConnectStatus = EConnectStatus.Disconnected

连接状态 是一个枚举类型

 enum EConnectStatus {
   Connected = 0,
   Disconnected = 1,
   Connecting = 2,
   Disconnecting = 3,
   ConnectFail = 4,
   DisconnectFail = 5,
 }

Optional Readonly deviceType

deviceType?: DeviceType

硬件协议的设备类型，会在 DeviceConnection 实例化的时候被注入

Readonly eventbus

eventbus: DeviceEventbusInterface

硬件协议的事件 bus，会在 DeviceConnection 实例化的时候被注入

Protected Optional socketoptions

socketoptions?: UDPRegisterOptions

Methods

_bindUDPEvent

  • _bindUDPEvent(): void

  • Returns void

_onClose

  • _onClose(): void

  • Returns void

_onConnect

  • _onConnect(): void

  • Returns void

_onError

  • _onError(error: any): Promise<void>

  • Parameters

    • error: any

    Returns Promise<void>

_onListening

  • _onListening(): Promise<void>

  • bind后监听事件

    Returns Promise<void>

_onReceived

  • _onReceived(msg: Buffer, rinfo: AddressInfo): Promise<void>

  • 接收数据

    Parameters

    • msg: Buffer

      数据，buffer格式

    • rinfo: AddressInfo

      socket远程地址

    Returns Promise<void>

_setOptions

  • _setOptions(): Promise<void>

  • 设置UDP对象参数

    Returns Promise<void>

_unbindUDPEvent

  • _unbindUDPEvent(): void

  • Returns void

afterConnect

  • afterConnect(): Promise<void>

afterDisconnect

  • afterDisconnect(): Promise<void>

beforeConnect

  • beforeConnect(): Promise<void>

beforeDestroy

  • beforeDestroy(): Promise<void>

  • 销毁前的钩子 该方法在执行断开之前执行，可以用于发送指令 该方法可以被重写

    virtual

    Returns Promise<void>

    Promise

beforeDisconnect

  • beforeDisconnect(): Promise<void>

connect

destroy

  • destroy(): Promise<void>

disconnect

  • disconnect(): Promise<void>

initSocket

  • initSocket(): Promise<void>

  • Returns Promise<void>

isConnected

  • isConnected(): boolean

onData

  • onData(listener: (data: UDPMsg) => void): Disposable

  • 监听数据事件

    Parameters

    • listener: (data: UDPMsg) => void

      监听callback

    Returns Disposable

    Disposal

send

  • 数据发送

    Parameters

    • msg: UDPMsg

      数据

    • Optional isTopPriority: boolean

      是否为最高优先级指令。如停止指令，不进入队列，直接发送并清空队列

    • Optional options: UDPSendOptionsType

      udp发送选项

    Returns Promise<number>

    返回已发送的数据字节数

Generated using TypeDoc