Options
All
  • Public
  • Public/Protected
  • All
Menu

WebSocket Paired Clover Transport

Implements code that is used to pair with a device. Depending on the application running on a device, a pairing protocol may be needed to successfully connect. This implementation sends the pairing request when the websocket is opened.

Hierarchy

Implements

Index

Constructors

constructor

  • new WebSocketPairedCloverTransport(endpoint: string, heartbeatInterval: number, reconnectDelay: number, retriesUntilDisconnect: number, posName: string, serialNumber: string, authToken: string, webSocketImplClass: any): WebSocketPairedCloverTransport

Properties

Private authToken

authToken: string

Private endpoint

endpoint: string

isPairing

isPairing: boolean = true

Protected logger

logger: Logger = Logger.create()

messageParser

messageParser: RemoteMessageParser

Protected objectMessageSender

objectMessageSender: ObjectMessageSender

Protected observers

observers: CloverTransportObserver[] = []

pairingDeviceConfiguration

pairingDeviceConfiguration: PairingDeviceConfiguration

Private posName

posName: string

Protected ready

ready: Boolean = false

reconnector

reconnector: any = function() {if (!this.shutdown) {try {this.initialize();} catch (e) {this.reconnect();}}}.bind(this)

Private serialNumber

serialNumber: string

shutdown

shutdown: boolean = false

prevent reconnects if shutdown was requested

status

status: string = "Disconnected"

webSocket

webSocketImplClass

webSocketImplClass: any

This is the WebSocket implementation. This is odd, but it is how we can keep ourselves from being tied to a browser.

A NodeJS app that uses this library would pass in a different object than a browser implementation. NodeJS has an object that satisfies the requirements of the WebSocket (looks the same).

https://www.npmjs.com/package/websocket

Static METHOD

METHOD: string = "method"

Static PAYLOAD

PAYLOAD: string = "payload"

Methods

clearListeners

  • clearListeners(): void

connectionError

dispose

  • dispose(): void

Protected initialize

  • initialize(): void

Protected initializeWithUri

  • initializeWithUri(deviceEndpoint: string): void

Protected notifyDeviceConnected

  • notifyDeviceConnected(): void

Protected notifyDeviceDisconnected

  • notifyDeviceDisconnected(): void

Protected notifyDeviceReady

  • notifyDeviceReady(): void

onClose

onMessage

onMessage_cwscl

onNotResponding

onOpen

onPingResponding

onSendError

  • onSendError(payloadText: string): void

reconnect

  • reconnect(): void

reset

  • reset(): void

sendMessage

  • sendMessage(message: string): number

Private sendPairRequest

  • sendPairRequest(): void

setObjectMessageSender

setPairingDeviceConfiguration

subscribe

unsubscribe

Generated using TypeDoc