Options
All
  • Public
  • Public/Protected
  • All
Menu

TCP客户端连接器。有抽象方法,即需要子类实现获取设备信息的方法。

Hierarchy

  • TCPClientConnection

Implements

Index

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

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

Static LogDomain

LogDomain: string = 'TCPClientConnection'

Methods

_setOptions

  • _setOptions(): Promise<void>
  • 设置TCP对象参数

    Returns Promise<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>

Protected Abstract getDeviceInfo

initTcp

  • initTcp(): Promise<void>
  • 创建TCP客户端,设置参数

    Returns Promise<void>

isConnected

  • isConnected(): boolean

Protected onClose

  • onClose(): void
  • 当TCP断开连接

    Returns void

Protected onConnect

  • onConnect(): void
  • 当TCP连接完成

    Returns void

onData

  • onData(listener: (data: string | Buffer) => void): Disposable
  • 监听数据事件

    Parameters

    • listener: (data: string | Buffer) => void

      监听callback

        • (data: string | Buffer): void
        • Parameters

          • data: string | Buffer

          Returns void

    Returns Disposable

    Disposal

Protected onDrain

  • onDrain(): void
  • Returns void

Protected onEnd

  • onEnd(): void
  • Returns void

Protected onError

  • onError(error: any): Promise<void>
  • 当TCP出现error

    Parameters

    • error: any

    Returns Promise<void>

Protected onLookup

  • onLookup(err: Error, address: string, family: string | number, host: string): void
  • Parameters

    • err: Error
    • address: string
    • family: string | number
    • host: string

    Returns void

Protected onReady

  • onReady(): void
  • Returns void

Protected onReceived

  • onReceived(msg: string | Buffer): Promise<void>
  • 接收数据

    Parameters

    • msg: string | Buffer

      数据,buffer 或 string 格式

    Returns Promise<void>

onSocketEvent

  • onSocketEvent(listener: (data?: SocketEventType) => void): Disposable
  • 一些tcp socket事件,包括drain, end, lookup, ready, timeout事件

    Parameters

    • listener: (data?: SocketEventType) => void
        • (data?: SocketEventType): void
        • Parameters

          • Optional data: SocketEventType

          Returns void

    Returns Disposable

Protected onTimeout

  • onTimeout(): void
  • Returns void

write

  • write(msg: TCPMsg, isTopPriority?: boolean, encoding?: BufferEncoding): Promise<number | { error?: Error; flushed: boolean }>
  • 数据发送

    Parameters

    • msg: TCPMsg

      数据

    • Optional isTopPriority: boolean

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

    • Optional encoding: BufferEncoding

    Returns Promise<number | { error?: Error; flushed: boolean }>

    返回已发送的数据字节数

Generated using TypeDoc