Buffered-message NPM

buffered-message

Basic module for buffered messages

Examples

All provided examples work exactly the same

Example 1 - using `writeSigned()` function

const { MessageBuffer, MESSAGE_HEADER, MESSAGE_FOOTER } = require("buffered-message")

let messageBuffer = new MessageBuffer();

for(let i = 1; i <= 3; i++)
    messageBuffer.writeSigned("test" + i);

let task1 = messageBuffer.read(1);
let task2 = messageBuffer.read(2);

Promise.all([task1, task2]).then(values => {
    console.log(values.toString());
})

Example 2 - using `write()` function with `writeHeader()` and `writeFooter()`

const { MessageBuffer, MESSAGE_HEADER, MESSAGE_FOOTER } = require("buffered-message")

let messageBuffer = new MessageBuffer();

for(let i = 1; i <= 3; i++){
    messageBuffer.writeHeader();
    messageBuffer.write("test" + i);
    messageBuffer.writeFooter();
}

let task1 = messageBuffer.read(1);
let task2 = messageBuffer.read(2);

Promise.all([task1, task2]).then(values => {
    console.log(values.toString());
})

Example 3 - using `write()` function with `MESSAGE_HEADER` and `MESSAGE_FOOTER` constants

const { MessageBuffer, MESSAGE_HEADER, MESSAGE_FOOTER } = require("buffered-message")

let messageBuffer = new MessageBuffer();

for(let i = 1; i <= 3; i++){
    messageBuffer.write(MESSAGE_HEADER);
    messageBuffer.write("test" + i);
    messageBuffer.write(MESSAGE_FOOTER);
}

let task1 = messageBuffer.read(1);
let task2 = messageBuffer.read(2);

Promise.all([task1, task2]).then(values => {
    console.log(values.toString());
})

Documentation

BufferedMessage

Function	Description
`BufferedMessage.mainBuffer()`	Returns referenct to a buffer
`BufferedMessage.size()`	Returns size of buffer in bytes
`BufferedMessage.count()`	Returns number of messages remaining in buffer
`BufferedMessage.writeHeader()`	Writes message header to buffer
`BufferedMessage.writeFooter()`	Writes message footer to buffer
`BufferedMessage.write(data)`	Writes `data` to buffer
`BufferedMessage.writeSigned(data)`	Writes `data` to buffer with header and footer
`BufferedMessage.read(n)`	Reads `n` messages from buffer; default `n = 1`