summaryrefslogtreecommitdiff
path: root/include/ouroboros/qos.h
blob: 6391347a05044df9f1b18faa9ff24bf8793daa86 (plain)
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*
 * Ouroboros - Copyright (C) 2016 - 2021
 *
 * Quality of Service specification
 *
 *    Dimitri Staessens <dimitri@ouroboros.rocks>
 *    Sander Vrijders   <sander@ouroboros.rocks>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., http://www.fsf.org/about/contact/.
 */

#ifndef OUROBOROS_QOS_H
#define OUROBOROS_QOS_H

#include <stdint.h>
#include <stdbool.h>

typedef struct qos_spec {
        uint32_t delay;         /* In ms */
        uint64_t bandwidth;     /* In bits/s */
        uint8_t  availability;  /* Class of 9s */
        uint32_t loss;          /* Packet loss */
        uint32_t ber;           /* Bit error rate, errors per billion bits */
        uint8_t  in_order;      /* In-order delivery, enables FRCT */
        uint32_t max_gap;       /* In ms */
        uint16_t cypher_s;      /* Cypher strength, 0 = no encryption */
} qosspec_t;

static const qosspec_t qos_raw = {
        .delay        = UINT32_MAX,
        .bandwidth    = 0,
        .availability = 0,
        .loss         = 1,
        .ber          = 1,
        .in_order     = 0,
        .max_gap      = UINT32_MAX,
        .cypher_s     = 0
};

static const qosspec_t qos_raw_no_errors = {
        .delay        = UINT32_MAX,
        .bandwidth    = 0,
        .availability = 0,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 0,
        .max_gap      = UINT32_MAX,
        .cypher_s     = 0
};

static const qosspec_t qos_raw_crypt = {
        .delay        = UINT32_MAX,
        .bandwidth    = 0,
        .availability = 0,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 0,
        .max_gap      = UINT32_MAX,
        .cypher_s     = 256
};

static const qosspec_t qos_best_effort = {
        .delay        = UINT32_MAX,
        .bandwidth    = 0,
        .availability = 0,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = UINT32_MAX,
        .cypher_s     = 0
};

static const qosspec_t qos_best_effort_crypt = {
        .delay        = UINT32_MAX,
        .bandwidth    = 0,
        .availability = 0,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = UINT32_MAX,
        .cypher_s     = 256
};

static const qosspec_t qos_video   = {
        .delay        = 100,
        .bandwidth    = UINT64_MAX,
        .availability = 3,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = 100,
        .cypher_s     = 0
};

static const qosspec_t qos_video_crypt   = {
        .delay        = 100,
        .bandwidth    = UINT64_MAX,
        .availability = 3,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = 100,
        .cypher_s     = 256
};

static const qosspec_t qos_voice = {
        .delay        = 50,
        .bandwidth    = 100000,
        .availability = 5,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = 50,
        .cypher_s     = 0
};

static const qosspec_t qos_voice_crypt = {
        .delay        = 50,
        .bandwidth    = 100000,
        .availability = 5,
        .loss         = 1,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = 50,
        .cypher_s     = 256
};

static const qosspec_t qos_data = {
        .delay        = 1000,
        .bandwidth    = 0,
        .availability = 0,
        .loss         = 0,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = 2000,
        .cypher_s     = 0
};

static const qosspec_t qos_data_crypt = {
        .delay        = 1000,
        .bandwidth    = 0,
        .availability = 0,
        .loss         = 0,
        .ber          = 0,
        .in_order     = 1,
        .max_gap      = 2000,
        .cypher_s     = 256
};

#endif /* OUROBOROS_QOS_H */