tobytcpTobyTcp is a protocol that allows for the use of a raw tcp stream for communicating messages, bi-directionally. It frames the messages with a length prefix to deliniate messages. This library provides methods to encode/decode that message prefix, but also provides async send & receive methods.
NOTE: Maybe ready for Production use. See below Disclaimer section.
Look at the /examples and the unit tests for compiling examples!
```rust
let prefix = protocol::tobytcp_prefix(data.len());
stream.writeall(&prefix)?; stream.writeall(&data)?;
// OR use the send method in lib, which does almost exactly ^ send(&mut data, &mut stream).await?; ```
Look at the /examples and the unit tests for compiling examples!
```rust
let mut lenbuf = [0; 8];
stream.readexact(&mut lenbuf)?;
let length = protocol::tobytcplen(len_buf);
let mut msgbuf = [0; length as usize]; stream.readexact(&mut msgbuf)?; // Done, we have received the message into msgbuf
// OR use the receive method in lib which does almost exactly ^ let data = receive(&mut buf, &mut stream).await?;; ```
The TobyTcp protocol uses length prefixing for message framing.
Messages must be prefixed by eight (8) bytes, for a total of 64 bits. This 8 byte/64 bit segment of every message must contain the number of bytes present in the message being sent (NOT including the 8 bytes used for describing the size). The length prefix must be big-endian.
You can use the protocol module to retreive the prefix, which has the length of your data.
Here is an example of an encoded messages. The message has 18 bytes of data, and in the end, 18 + 8 = 26 bytes are sent, with the first 8 bytes representing the length.
00 00 00 00 00 00 00 12 74 6f 62 79 20 69 73 20 61 20 67 6f 6f 64 20 64 6f 67
Also see the protocol tests to see what is expected!
async methods that are not usable with stable rust (check out areweasyncyet!), which is a large blocker for me considering this 1.0.
async methods behind a 'feature', but I'm unsure how to do that and no-one uses this so...32 bit machines, not sure it will work!The University of Illinois/NCSA (National Center for Supercomputing Applications) Open Source License
See LICENSE file. This a permissive open source license similar to Apache-2.0.