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

// Copyright (c) 2018 Timo Savola.
// Use of this source code is governed by the MIT
// license that can be found in the LICENSE file.

//! # Gate interface
//!
//! ## Asynchronous execution
//!
//! The [`task`](task) module provides a framework for spawning and running
//! asynchronous tasks.
//!
//! A typical program runs a single top-level task:
//!
//! ```
//! use gain::task::{block_on, spawn};
//!
//! fn main() {
//!     block_on(async {
//!         spawn(concurrent_work());
//!         do_something().await;
//!     })
//! }
//!
//! async fn concurrent_work() {
//!     do_stuff().await;
//! }
//! ```
//!
//! Concurrency is achieved by spawning more tasks.  The program exits when the
//! top-level task returns.
//!
//! ## Service APIs
//!
//! The [`catalog`](catalog), [`identity`](identity), [`origin`](origin),
//! [`peer`](peer) and [`peerindex`](peerindex) modules provide access to the
//! built-in Gate services.
//!
//! Common I/O stream types are defined in the [`stream`](stream) module.
//!
//! ## Service implementation
//!
//! Additional service bindings can be implemented using the
//! [`service`](service) module.

#[macro_use]
extern crate lazy_static;

pub mod catalog;
mod core;
mod gate;
pub mod identity;
pub mod origin;
mod packet;
pub mod peer;
pub mod peerindex;
pub mod service;
pub mod stream;
pub mod task;
mod threadunsafe;