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
77
78
79
80
81
82
83
84

//
// Copyright 2022 Sebastian Urban <surban@surban.net>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

#![forbid(unsafe_code)]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/surban/aggligator/master/.misc/aggligator.png",
    html_favicon_url = "https://raw.githubusercontent.com/surban/aggligator/master/.misc/aggligator.png",
    issue_tracker_base_url = "https://github.com/surban/aggligator/issues/"
)]

//! Utilities for working with the [Aggligator link aggregator](aggligator).
//!
//! This crate provides utility functions and command line tools for working with the
//! Aggligator link aggregator.
//!
//! It provides the following modules:
//!   * functions for establishing a connection consisting of [aggregated TCP links](net)
//!     with optional TLS encryption,
//!   * a text-based, interactive [connection and link montor](monitor),
//!   * a [speed test](speed).
//!
//! The following command line tools are included:
//!   * `agg-speed` — performs a speed test over a connection of aggregated TCP links,
//!   * `agg-tunnel` — forwards arbitrary TCP ports over a connection of aggregated TCP links.
//!
//! Both tools display a text-based, interactive connection and link monitor.
//!
//! #### Simple aggregation of TCP links
//! Use the [tcp_connect](net::tcp_connect) and [tcp_server](net::tcp_server) functions
//! from the [net module](net).
//!
//! #### Encryption and authentication using TLS
//! Use the [tls_connect](net::tls_connect) and [tls_server](net::tls_server) functions
//! from the [net module](net).
//!

#[cfg(feature = "cli")]
#[doc(hidden)]
pub mod cli;
#[cfg(feature = "monitor")]
#[cfg_attr(docsrs, doc(cfg(feature = "monitor")))]
pub mod monitor;
pub mod net;
#[cfg(feature = "speed-test")]
#[cfg_attr(docsrs, doc(cfg(feature = "speed-test")))]
pub mod speed;

use aggligator::id::ConnId;

/// Link tag error information.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct TagError<TAG> {
    /// Connection id.
    pub id: ConnId,
    /// Link tag.
    pub tag: TAG,
    /// Error message.
    pub msg: String,
}

impl<TAG> TagError<TAG>
where
    TAG: Clone,
{
    /// Creates new link tag error information.
    pub fn new(id: ConnId, tag: &TAG, msg: impl ToString) -> Self {
        Self { id, tag: tag.clone(), msg: msg.to_string() }
    }
}