Class ButtplugBrowserWebsocketClientConnector

Hierarchy (view full)

ButtplugBrowserWebsocketConnector
- ButtplugBrowserWebsocketClientConnector
  - ButtplugNodeWebsocketClientConnector

Implements

IButtplugClientConnector

Index

Constructors

Properties

_websocketConstructor _ws

Accessors

Methods

connect disconnect initialize onReaderLoad parseIncomingMessage send sendMessage

Constructors

constructor

new ButtplugBrowserWebsocketClientConnector(_url): ButtplugBrowserWebsocketClientConnector
Parameters
- _url: string
Returns ButtplugBrowserWebsocketClientConnector
Inherited from ButtplugBrowserWebsocketConnector.constructor
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:19

Properties

`Protected` _websocketConstructor

_websocketConstructor: null | (new (url, protocols?) => WebSocket) = null

Type declaration

- new (url, protocols?): WebSocket
- Parameters
  - url: string | URL
  - Optional protocols: string | string[]
  Returns WebSocket

`Protected` _ws

_ws: undefined | WebSocket

Accessors

Connected

get Connected(): boolean
Returns boolean
Implementation of IButtplugClientConnector.Connected
Inherited from ButtplugBrowserWebsocketConnector.Connected
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:23

Methods

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of IButtplugClientConnector.connect
Inherited from ButtplugBrowserWebsocketConnector.connect
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:27

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Implementation of IButtplugClientConnector.disconnect
Inherited from ButtplugBrowserWebsocketConnector.disconnect
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:56

initialize

initialize(): Promise<void>
Returns Promise<void>
Implementation of IButtplugClientConnector.initialize
Inherited from ButtplugBrowserWebsocketConnector.initialize
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:72

`Protected` onReaderLoad

onReaderLoad(event): void
Parameters
- event: Event
Returns void
Inherited from ButtplugBrowserWebsocketConnector.onReaderLoad
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:85

`Protected` parseIncomingMessage

parseIncomingMessage(event): void
Parameters
- event: MessageEvent<any>
Returns void
Inherited from ButtplugBrowserWebsocketConnector.parseIncomingMessage
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:76

send

send(msg): void
Parameters
- msg: ButtplugMessage
Returns void
Implementation of IButtplugClientConnector.send
- Defined in src/client/ButtplugBrowserWebsocketClientConnector.ts:19

sendMessage

sendMessage(msg): void
Parameters
- msg: ButtplugMessage
Returns void
Inherited from ButtplugBrowserWebsocketConnector.sendMessage
- Defined in src/utils/ButtplugBrowserWebsocketConnector.ts:65

Generated using TypeDoc