Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UDP

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

DiscoverDeviceData

DiscoverDeviceData: { address?: string; buffer: Buffer; port?: number }

搜索设备时，设备对象中包含的data数据，会在connection时使用

Type declaration

  • Optional address?: string
  • buffer: Buffer
  • Optional port?: number

UDPRegisterOptions

UDPRegisterOptions: { bindAddress?: string; bindPort?: number; isBroadcast?: boolean; multicastAddress?: string; multicastInterface?: string; multicastLoopback?: boolean; multicastTTL?: number; queueOptions?: QueueConstructorType; recvBufferSize?: number; scanTime?: number; sendAddress?: string; sendBufferSize?: number; sendMsgForDiscover?: UDPMsg; sendMsgForResponse?: UDPMsg; sendPort?: number; ttl?: number; udpConstructorOptions: UDP.UDPConstructorOptions | UDP.UDPSocketType; customDeviceName?: any }

Type declaration

  • Optional bindAddress?: string

    监听消息时，绑定的地址

  • Optional bindPort?: number

    监听消息时，绑定的端口

  • Optional isBroadcast?: boolean

    设置广播？

  • Optional multicastAddress?: string

    设置多播地址，在 addMembership 或 dropMembership 使用

  • Optional multicastInterface?: string

    将套接字的默认传出多播接口设置为所选接口或返回系统接口选择

  • Optional multicastLoopback?: boolean

    设置或取消 IP_MULTICAST_LOOP 选项

  • Optional multicastTTL?: number

    设置 IP_MULTICAST_TTL 选项

  • Optional queueOptions?: QueueConstructorType

    队列参数，可以设置 队列 发送的 间隔 或者 数量

  • Optional recvBufferSize?: number

    设置接收消息的缓存大小

  • Optional scanTime?: number

    扫描超时

  • Optional sendAddress?: string

    发送消息时，发送数据的地址

  • Optional sendBufferSize?: number

    设置发送消息的缓存大小

  • Optional sendMsgForDiscover?: UDPMsg

    发消息来触发设备回应？

  • Optional sendMsgForResponse?: UDPMsg

    收到消息后，发送一条固定的消息回应？

  • Optional sendPort?: number

    发送消息时，发送数据的端口

  • Optional ttl?: number

    设置 IP_TTL 选项

  • udpConstructorOptions: UDP.UDPConstructorOptions | UDP.UDPSocketType

    UDP创建socket时构造函数的参数

  • customDeviceName?:function

    • 自定义设备名，可以从socket数据中加工出新名字

      Parameters

      Returns string

Variables

UDPDeviceType

UDPDeviceType: DiscoverDeviceType = ...

Functions

getUDPDeviceRegister

getUDPDeviceType

  • getUDPDeviceType(options: { scanTime?: number }): { connectType: "discover"; icon?: string; id: string; name: string; needUcodelink: boolean; scanTime: undefined | number; skipDuplicate?: boolean; tip?: DeviceConnectionTip }

  • Parameters

    • options: { scanTime?: number }
      • Optional scanTime?: number

    Returns { connectType: "discover"; icon?: string; id: string; name: string; needUcodelink: boolean; scanTime: undefined | number; skipDuplicate?: boolean; tip?: DeviceConnectionTip }

    • Readonly connectType: "discover"
    • Optional icon?: string

      图标 支持 base64 或者 url, 大小在 128x128 或者 256x256 512x512 更佳

    • id: string

      唯一 ID

    • name: string

      名字

    • needUcodelink: boolean
    • scanTime: undefined | number
    • Optional skipDuplicate?: boolean

      是否要过滤已经连接过的设备, device.id 作为唯一标识, 默认过滤

    • Optional tip?: DeviceConnectionTip

      连接提示

Generated using TypeDoc