ymmp 0.1.0

Yumetter Messaging Protocol
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# 🌏 YMMP: Yumetter Messaging Protocol

## Prerequisites
- Rust Toolchain 1.53.0+

## Summary
YMMP is a protocol for broadcast a notification to all nodes within the network or subnet, made for Yumetter project.
The lower layer protocol is UDP (User Diagram Protocol), and uses port 17339 by default.

## Usage
```rust
use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4};

fn main() {
    let addr = SocketAddrV4::new(Ipv4Addr::LOCALHOST, 17339);
    let target = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::BROADCAST, 17339));
    let broadcaster = ymmp::Broadcaster::bind(addr, target);

    let message = vec![b'h', b'e', b'l', b'l', b'o'];
    let packet = ymmp::Packet::new(message);

    broadcaster
        .broadcast(packet)
        .expect("Failed to broadcast.")
    ;
}
```

## Diagram
<table>
  <thead>
    <tr>
      <th></th>
      <th>0</th>
      <th>1</th>
      <th>2</th>
      <th>3</th>
      <th>4</th>
      <th>5</th>
      <th>6</th>
      <th>7</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row">0</th>
      <td colspan="4">Magic Bytes (<code>YMMP</code>)</td>
      <td colspan="4">Version (<code>v0.1</code>)</td>
    </tr>
    <tr>
      <th scope="row">8</th>
      <td colspan="8">Length of Message (Little Endian)</td>
    </tr>
    <tr>
      <th scope="row">16</th>
      <td colspan="8" rowspan="2">Raw Message (0..N octets)</td>
    </tr>
    <tr>
      <th scope="row">32</th>
    </tr>
  </tbody>
</table>