brisk-js

brisk connection over js-flux

Usage no npm install needed!

<script type="module">
  import briskJs from 'https://cdn.skypack.dev/brisk-js';
</script>

README

Table of Contents

WriteCallback
- Parameters
ReadCallback
- Parameters
CallbackInfo
- Properties
LogInfo
- Properties
BriskConnection
- Parameters

WriteCallback

Called when the application should write the next command

Parameters

octetStream OutOctetStream

ReadCallback

Called everytime there is a new command to be processed

Parameters

cmdValue uint8
octetStream InOctetStream

CallbackInfo

Type: Object

Properties

readCallback ReadCallback read callback
writeCallback WriteCallback write callback

LogInfo

Type: Object

Properties

log function log function

BriskConnection

Establishing a websocket connection that is intended to be bridged over UDP.

Parameters

host string web socket connection, e.g. 'ws://demos.kaazing.com/echo'
info CallbackInfo read and write callback
log LogInfo object that contains a log() function.