simple-message-channels 0.2.0

Simple binary protocol with a channel, type, message scheme
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! Simple message channels
//!
//! A reader and writer for messages in the "simple message channels"(SMC) binary protocol. The
//! protocol encodes message in a simple pattern of (channel, type, message), where channel can
//! be any number, type can be any number between 0 and 15, and message can be any byte buffer.
//!
//! This is the basic wire protocol used by [hypercore](https://github.com/mafintosh/hypercore).
//!
//! This module is a port of the JavaScript module [of the same
//! name](https://github.com/mafintosh/simple-message-channels/).

mod message;
mod reader;
mod writer;

pub use message::Message;
pub use reader::Reader;
pub use writer::send;
pub use writer::send_batch;
pub use writer::Writer;

/// The max message size (in bytes)
///
/// The limit is arbitrary, and taken from the JavaScript implementation.
/// (see: https://github.com/mafintosh/simple-message-channels/blob/master/index.js)
/// TODO: This should be configurable.
pub const MAX_MESSAGE_SIZE: u64 = 1024 * 1024 * 8;