protocol/test/protocols.js

Protocols for Node.JS

/*
 * MIT License
 *
 * Copyright (c) 2017 Wouter Klijn <contact@wuhkuh.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

'use strict'

const Protocol = require('../')
const dicts = require('./dicts')

const linearProtocol = new Protocol({
  header: { bitLength: 4, dict: dicts.linearDict.header },
  flag1: { bitLength: 1 },
  flag2: { bitLength: 1 },
  flag3: { bitLength: 2 }
})

const embeddedProtocol = new Protocol({
  firstBits: [{
    firstBit: { bitLength: 1 },
    secondBit: { bitLength: 1 }
  }],
  firstNibble: { bitLength: 4 }
})

const dynamicProtocol = new Protocol({
  header: [{
    bit1: { bitLength: 1 },
    bit2: { bitLength: 2 },
    bit3: { bitLength: 2 },
    bit4: { bitLength: 3 }
  }],
  payloadLength: { bitLength: 4 },
  payload: { byteLength: 'payloadLength', encoding: 'utf8' },
  next: { bitLength: 4 }
})

const bufferOnly = new Protocol({
  buffer1: { byteLength: 4, encoding: 'utf8' },
  buffer2: { byteLength: 4, encoding: 'utf8' }
})

module.exports = { linearProtocol, embeddedProtocol, dynamicProtocol, bufferOnly }