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
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Laminar semi-reliable UDP protocol for multiplayer games. This library implements wraps around a UDP
//! and provides light weight stream based interface that provides certain guarantees like reliability.
//!
//! Laminar was designed to be used within the [Amethyst][amethyst] game engine.
//!
//! [amethyst]: https://github.com/amethyst/amethyst
//!
//! # Concepts
//!
//! This library is mostly based off of [Gaffer on Games][gog] and shares features with RakNet. The idea is to provide a low level
//! UDP protocol that supports the use cases of video games that require multilayer features. The library
//! itself provides a few low level types of packets that provides different types of guarantees. The most
//! basic are unreliable and reliable packets. This generally correlates to state update packets that do not
//! require to be synced, meaning the packet can get dropped without harm to the game. The other is used for
//! example score updates, where you want to make sure that the data is received on the other end even in case
//! of a packet drop. For more information, read the projects [README.md][readme]
//!
//! [gog]: https://gafferongames.com/
//! [readme]: https://github.com/amethyst/laminar/blob/master/README.md
//!
//! # Example
//!
//! ```rust
//! extern crate laminar;
//!
//! use laminar::{Packet, net::UdpSocket};
//! use laminar::config::NetworkConfig;
//!
//! use std::net::Ipv4Addr;
//!
//! fn main() {
//!   let addr = "127.0.0.1:12345".parse().unwrap();
//!
//!   let mut socket = UdpSocket::bind(addr, NetworkConfig::default()).unwrap();
//!
//!   let data = "example data".as_bytes();
//!   let packet: Packet = Packet::reliable_unordered(addr, data.to_vec());
//!
//!   socket.send(&packet).unwrap();
//!
//!   let data = socket.recv().unwrap();
//!   println!("{:?}", data);
//! }
//! ```

#![warn(missing_docs)]

extern crate bincode;
extern crate byteorder;
extern crate crc;
extern crate failure;
extern crate failure_derive;
extern crate lazy_static;
extern crate log;
extern crate rand;
extern crate serde;

mod events;
mod infrastructure;
mod packet;
mod protocol_version;
mod sequence_buffer;


/// All internal error handling logic
pub mod error;
/// Networking modules
pub mod net;
/// Contains networking related configuration
pub mod config;

pub use events::Event;
pub use infrastructure::DeliveryMethod;
pub use packet::Packet;
pub use protocol_version::ProtocolVersion;
pub use config::NetworkConfig;