YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
QosStyle.cpp
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6#include <yarp/os/QosStyle.h>
7#include <yarp/os/Vocab.h>
8
9#include <cstdlib>
10#include <string>
11
12
14 threadPriority(-1),
15 threadPolicy(-1),
16 packetPriority(-1)
17{
18}
19
21{
22 if (dscp != DSCP_Invalid && dscp != DSCP_Undefined) {
23 packetPriority = ((int)dscp) << 2;
24 } else {
25 packetPriority = -1;
26 }
27}
28
29
31{
32 if (level != PacketPriorityInvalid && level != PacketPriorityUndefined) {
33 packetPriority = ((int)level) << 2;
34 } else {
35 packetPriority = -1;
36 }
37}
38
39bool yarp::os::QosStyle::setPacketPriority(const std::string& priority)
40{
41 size_t p = priority.find(':');
42 if (p == std::string::npos) {
43 return false;
44 }
45
46 std::string key = priority.substr(0, p);
47 std::string value = priority.substr(p + 1);
48 if (key.length() <= 0 || value.length() <= 0) {
49 return false;
50 }
51
52 if (key == "LEVEL") {
53 PacketPriorityLevel level = getLevelByVocab(yarp::os::Vocab32::encode(value));
54 if (level != PacketPriorityInvalid && level != PacketPriorityUndefined) {
55 setPacketPriorityByLevel(level);
56 return true;
57 }
58 } else if (key == "DSCP") {
59 PacketPriorityDSCP dscp = getDSCPByVocab(yarp::os::Vocab32::encode(value));
60 if (dscp != DSCP_Invalid && dscp != DSCP_Undefined) {
61 setPacketPriorityByDscp(dscp);
62 return true;
63 }
64 } else if (key == "TOS") {
65 // the whole value must be an integer in the range of the TOS byte
66 char* end = nullptr;
67 long tos = strtol(value.c_str(), &end, 10);
68 if (end != value.c_str() && *end == '\0' && tos >= 0 && tos <= 255) {
69 setPacketPrioritybyTOS(static_cast<int>(tos));
70 return true;
71 }
72 }
73
74 packetPriority = -1;
75 return false;
76}
77
79{
80 switch (packetPriority) {
81 case -1:
82 return DSCP_Invalid;
83 case (0 << 2):
84 return DSCP_CS0;
85 case (8 << 2):
86 return DSCP_CS1;
87 case (16 << 2):
88 return DSCP_CS2;
89 case (24 << 2):
90 return DSCP_CS3;
91 case (32 << 2):
92 return DSCP_CS4;
93 case (40 << 2):
94 return DSCP_CS5;
95 case (48 << 2):
96 return DSCP_CS6;
97 case (56 << 2):
98 return DSCP_CS7;
99 case (10 << 2):
100 return DSCP_AF11;
101 case (12 << 2):
102 return DSCP_AF12;
103 case (14 << 2):
104 return DSCP_AF13;
105 case (18 << 2):
106 return DSCP_AF21;
107 case (20 << 2):
108 return DSCP_AF22;
109 case (22 << 2):
110 return DSCP_AF23;
111 case (26 << 2):
112 return DSCP_AF31;
113 case (28 << 2):
114 return DSCP_AF32;
115 case (30 << 2):
116 return DSCP_AF33;
117 case (34 << 2):
118 return DSCP_AF41;
119 case (36 << 2):
120 return DSCP_AF42;
121 case (38 << 2):
122 return DSCP_AF43;
123 case (44 << 2):
124 return DSCP_VA;
125 case (46 << 2):
126 return DSCP_EF;
127 default:
128 return DSCP_Undefined;
129 }
130}
131
133{
134 switch (packetPriority) {
135 case -1:
136 return PacketPriorityInvalid;
137 case (0 << 2):
138 return PacketPriorityNormal;
139 case (10 << 2):
140 return PacketPriorityLow;
141 case (36 << 2):
142 return PacketPriorityHigh;
143 case (44 << 2):
144 return PacketPriorityCritical;
145 default:
146 return PacketPriorityUndefined;
147 }
148}
149
150
151// | | Class 1 | Class 2 | Class 3 | Class 4 |
152// |-----------|----------------|----------------|----------------|----------------|
153// | Low Drop | AF11 (DSCP 10) | AF21 (DSCP 18) | AF31 (DSCP 26) | AF41 (DSCP 34) |
154// | Med Drop | AF12 (DSCP 12) | AF22 (DSCP 20) | AF32 (DSCP 28) | AF42 (DSCP 36) |
155// | High Drop | AF13 (DSCP 14) | AF23 (DSCP 22) | AF33 (DSCP 30) | AF43 (DSCP 38) |
157{
158 switch (vocab) {
159 case yarp::os::createVocab32('C', 'S', '0'):
160 return DSCP_CS0;
161 case yarp::os::createVocab32('C', 'S', '1'):
162 return DSCP_CS1;
163 case yarp::os::createVocab32('C', 'S', '2'):
164 return DSCP_CS2;
165 case yarp::os::createVocab32('C', 'S', '3'):
166 return DSCP_CS3;
167 case yarp::os::createVocab32('C', 'S', '4'):
168 return DSCP_CS4;
169 case yarp::os::createVocab32('C', 'S', '5'):
170 return DSCP_CS5;
171 case yarp::os::createVocab32('C', 'S', '6'):
172 return DSCP_CS6;
173 case yarp::os::createVocab32('C', 'S', '7'):
174 return DSCP_CS7;
175 case yarp::os::createVocab32('A', 'F', '1', '1'):
176 return DSCP_AF11;
177 case yarp::os::createVocab32('A', 'F', '1', '2'):
178 return DSCP_AF12;
179 case yarp::os::createVocab32('A', 'F', '1', '3'):
180 return DSCP_AF13;
181 case yarp::os::createVocab32('A', 'F', '2', '1'):
182 return DSCP_AF21;
183 case yarp::os::createVocab32('A', 'F', '2', '2'):
184 return DSCP_AF22;
185 case yarp::os::createVocab32('A', 'F', '2', '3'):
186 return DSCP_AF23;
187 case yarp::os::createVocab32('A', 'F', '3', '1'):
188 return DSCP_AF31;
189 case yarp::os::createVocab32('A', 'F', '3', '2'):
190 return DSCP_AF32;
191 case yarp::os::createVocab32('A', 'F', '3', '3'):
192 return DSCP_AF33;
193 case yarp::os::createVocab32('A', 'F', '4', '1'):
194 return DSCP_AF41;
195 case yarp::os::createVocab32('A', 'F', '4', '2'):
196 return DSCP_AF42;
197 case yarp::os::createVocab32('A', 'F', '4', '3'):
198 return DSCP_AF43;
199 case yarp::os::createVocab32('V', 'A'):
200 return DSCP_VA;
201 case yarp::os::createVocab32('E', 'F'):
202 return DSCP_EF;
203 default:
204 return DSCP_Invalid;
205 };
206}
207
208
210{
211 switch (vocab) {
212 case yarp::os::createVocab32('N', 'O', 'R', 'M'):
213 return PacketPriorityNormal;
214 case yarp::os::createVocab32('L', 'O', 'W'):
215 return PacketPriorityLow;
216 case yarp::os::createVocab32('H', 'I', 'G', 'H'):
217 return PacketPriorityHigh;
218 case yarp::os::createVocab32('C', 'R', 'I', 'T'):
219 return PacketPriorityCritical;
220 default:
221 return PacketPriorityInvalid;
222 }
223}
A mini-server for performing network communication in the background.
PacketPriorityDSCP
The PacketPriorityDSCP defines the packets quality of service (priority) using DSCP.
Definition QosStyle.h:45
bool setPacketPriority(const std::string &priority)
sets the packet priority from a string.
Definition QosStyle.cpp:39
static PacketPriorityLevel getLevelByVocab(yarp::conf::vocab32_t vocab)
returns the priority level
Definition QosStyle.cpp:209
PacketPriorityDSCP getPacketPriorityAsDSCP() const
returns the packet DSCP class
Definition QosStyle.cpp:78
QosStyle()
Constructor.
Definition QosStyle.cpp:13
static PacketPriorityDSCP getDSCPByVocab(yarp::conf::vocab32_t vocab)
returns the IPV4/6 DSCP value given as DSCP code
Definition QosStyle.cpp:156
PacketPriorityLevel
The PacketPriorityLevel defines the packets quality of service (priority) levels.
Definition QosStyle.h:30
void setPacketPriorityByDscp(PacketPriorityDSCP dscp)
sets the packet priority given as DSCP class
Definition QosStyle.cpp:20
void setPacketPriorityByLevel(PacketPriorityLevel level)
sets the packet priority given as PacketPriorityLevel
Definition QosStyle.cpp:30
PacketPriorityLevel getPacketPriorityAsLevel() const
returns the packet TOS value
Definition QosStyle.cpp:132
std::int32_t vocab32_t
Definition numeric.h:78
NetInt32 encode(const std::string &str)
Convert a string into a vocabulary identifier.
Definition Vocab32.cpp:11
constexpr yarp::conf::vocab32_t createVocab32(char a, char b=0, char c=0, char d=0)
Create a vocab from chars.
Definition Vocab32.h:27