Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contracts for parser functions #12

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 52 additions & 7 deletions lib/parser.js
Original file line number Diff line number Diff line change
@@ -1,41 +1,86 @@
'use strict';

const PROTOCOL_VERSION = 1;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In issue #3 2b for protocol version declared

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will use writeInt16LE to write this Number value to 2 bytes binary field @mille-nium

const HANDSHAKE_LENGTH = 36;
const PARCEL_LENGTH = 16;
const CHUNK_LENGTH = 12;

const parcel = (buffer) => {
const readParcel = (buffer) => {
// Read parcel from buffer
// Return parcel object
const rest = Buffer.from(buffer, 1, PARCEL_LENGTH);
return rest;
};

const chunk = (buffer) => {
const parcel = (
// Encode parcel structure to Buffer
// id, // parcelId: 4b
// type, // parcelType: 4b
// compression, // 1b: no = 0, gzip = 1
// encoding, // 1b: binary = 0, jstp = 1, json = 2, bson = 3, v8 = 4
// length // 8b
) => {
const parcel = Buffer.alloc(PARCEL_LENGTH);
parcel.writeInt8(0, 0);
// Write parcel fields to buffer
return parcel;
};

const readChunk = (buffer) => {
// Read chunkk from buffer
// Return chunk object
const rest = Buffer.from(buffer, 1, CHUNK_LENGTH);
return rest;
};

const handshake = (buffer) => {
const chunk = (
// Encode chunk structure to Buffer
// id, // parcelId: 4b
// flags, // 1b: more = 1, stop = 2, pause = 4, resume = 8
// length, // 2b
// payload // Buffer
) => {
const chunk = Buffer.alloc(CHUNK_LENGTH);
chunk.writeInt8(1, 0);
// Write chunk fields to buffer
return chunk;
};

const readHandshake = (buffer) => {
// Read handshake from buffer
// Return handshake object
const rest = Buffer.from(buffer, 0, HANDSHAKE_LENGTH);
return rest;
};

const handshake = (
// Encode handshake structure to Buffer
// status // 1b: 0 = new, 1 = restore
// reserved // 1b
// token // 32b (optional)
) => {
const handshake = Buffer.alloc(HANDSHAKE_LENGTH);
handshake.writeInt16LE(PROTOCOL_VERSION, 0);
// Write handshake to buffer
return handshake;
};

const structTypes = [
/* 0 */ parcel,
/* 1 */ chunk
/* 0 */ readParcel,
/* 1 */ readChunk
];

const structure = (buffer) => {
const readStruct = (buffer) => {
// Read structure from buffer
// Return parcel or chunk object
const structType = buffer.readInt8(0, true);
const parser = structTypes[structType];
if (parser) return parser(buffer);
};

module.exports = { structure, handshake, chunk, parcel };
module.exports = {
handshake, readHandshake,
chunk, readChunk,
parcel, readParcel,
readStruct
};