nfd-constants.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2023 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
25 
26 #include <boost/algorithm/string/predicate.hpp>
27 #include <boost/lexical_cast.hpp>
28 #include <istream>
29 #include <map>
30 #include <ostream>
31 
32 namespace ndn::nfd {
33 
34 std::ostream&
35 operator<<(std::ostream& os, FaceScope faceScope)
36 {
37  switch (faceScope) {
38  case FACE_SCOPE_NONE:
39  return os << "none";
41  return os << "non-local";
42  case FACE_SCOPE_LOCAL:
43  return os << "local";
44  }
45  return os << static_cast<unsigned>(faceScope);
46 }
47 
48 std::ostream&
49 operator<<(std::ostream& os, FacePersistency facePersistency)
50 {
51  switch (facePersistency) {
53  return os << "none";
55  return os << "persistent";
57  return os << "on-demand";
59  return os << "permanent";
60  }
61  return os << static_cast<unsigned>(facePersistency);
62 }
63 
64 std::ostream&
65 operator<<(std::ostream& os, LinkType linkType)
66 {
67  switch (linkType) {
68  case LINK_TYPE_NONE:
69  return os << "none";
71  return os << "point-to-point";
73  return os << "multi-access";
74  case LINK_TYPE_AD_HOC:
75  return os << "adhoc";
76  }
77  return os << static_cast<unsigned>(linkType);
78 }
79 
80 std::ostream&
81 operator<<(std::ostream& os, FaceEventKind faceEventKind)
82 {
83  switch (faceEventKind) {
84  case FACE_EVENT_NONE:
85  return os << "none";
86  case FACE_EVENT_CREATED:
87  return os << "created";
89  return os << "destroyed";
90  case FACE_EVENT_UP:
91  return os << "up";
92  case FACE_EVENT_DOWN:
93  return os << "down";
94  }
95  return os << static_cast<unsigned>(faceEventKind);
96 }
97 
98 std::istream&
99 operator>>(std::istream& is, RouteOrigin& routeOrigin)
100 {
101  using boost::algorithm::iequals;
102 
103  std::string s;
104  is >> s;
105 
106  if (iequals(s, "none"))
107  routeOrigin = ROUTE_ORIGIN_NONE;
108  else if (iequals(s, "app"))
109  routeOrigin = ROUTE_ORIGIN_APP;
110  else if (iequals(s, "autoreg"))
111  routeOrigin = ROUTE_ORIGIN_AUTOREG;
112  else if (iequals(s, "client"))
113  routeOrigin = ROUTE_ORIGIN_CLIENT;
114  else if (iequals(s, "autoconf"))
115  routeOrigin = ROUTE_ORIGIN_AUTOCONF;
116  else if (iequals(s, "nlsr"))
117  routeOrigin = ROUTE_ORIGIN_NLSR;
118  else if (iequals(s, "prefixann"))
119  routeOrigin = ROUTE_ORIGIN_PREFIXANN;
120  else if (iequals(s, "static"))
121  routeOrigin = ROUTE_ORIGIN_STATIC;
122  else {
123  // To reject negative numbers, we parse as a wider signed type, and compare with the range.
124  using RouteOriginUnderlyingType = std::underlying_type_t<RouteOrigin>;
125  static_assert(std::numeric_limits<RouteOriginUnderlyingType>::max() <= std::numeric_limits<int>::max());
126 
127  int v = -1;
128  try {
129  v = boost::lexical_cast<int>(s);
130  }
131  catch (const boost::bad_lexical_cast&) {
132  }
133 
134  if (v >= std::numeric_limits<RouteOriginUnderlyingType>::min() &&
135  v <= std::numeric_limits<RouteOriginUnderlyingType>::max()) {
136  routeOrigin = static_cast<RouteOrigin>(v);
137  }
138  else {
139  routeOrigin = ROUTE_ORIGIN_NONE;
140  is.setstate(std::ios::failbit);
141  }
142  }
143 
144  return is;
145 }
146 
147 std::ostream&
148 operator<<(std::ostream& os, RouteOrigin routeOrigin)
149 {
150  switch (routeOrigin) {
151  case ROUTE_ORIGIN_NONE:
152  return os << "none";
153  case ROUTE_ORIGIN_APP:
154  return os << "app";
156  return os << "autoreg";
157  case ROUTE_ORIGIN_CLIENT:
158  return os << "client";
160  return os << "autoconf";
161  case ROUTE_ORIGIN_NLSR:
162  return os << "nlsr";
164  return os << "prefixann";
165  case ROUTE_ORIGIN_STATIC:
166  return os << "static";
167  }
168  return os << static_cast<unsigned>(routeOrigin);
169 }
170 
171 std::ostream&
172 operator<<(std::ostream& os, RouteFlags routeFlags)
173 {
174  if (routeFlags == ROUTE_FLAGS_NONE) {
175  return os << "none";
176  }
177 
178  static const std::map<RouteFlags, std::string_view> knownBits = {
179  {ROUTE_FLAG_CHILD_INHERIT, "child-inherit"sv},
180  {ROUTE_FLAG_CAPTURE, "capture"sv}
181  };
182 
183  auto join = make_ostream_joiner(os, '|');
184  for (auto [bit, token] : knownBits) {
185  if ((routeFlags & bit) != 0) {
186  join = token;
187  routeFlags = static_cast<RouteFlags>(routeFlags & ~bit);
188  }
189  }
190 
191  if (routeFlags != ROUTE_FLAGS_NONE) {
192  join = AsHex{routeFlags};
193  }
194 
195  return os;
196 }
197 
198 } // namespace ndn::nfd
Helper class to convert a number to hexadecimal format, for use with stream insertion operators.
@ FACE_PERSISTENCY_NONE
@ FACE_PERSISTENCY_ON_DEMAND
face is on-demand
@ FACE_PERSISTENCY_PERSISTENT
face is persistent
@ FACE_PERSISTENCY_PERMANENT
face is permanent
@ ROUTE_ORIGIN_PREFIXANN
@ ROUTE_ORIGIN_AUTOREG
@ ROUTE_ORIGIN_AUTOCONF
@ FACE_SCOPE_LOCAL
face is local
@ FACE_SCOPE_NON_LOCAL
face is non-local
@ ROUTE_FLAG_CHILD_INHERIT
@ LINK_TYPE_AD_HOC
link is ad hoc
@ LINK_TYPE_MULTI_ACCESS
link is multi-access
@ LINK_TYPE_POINT_TO_POINT
link is point-to-point
@ FACE_EVENT_DOWN
face went DOWN (from UP state)
@ FACE_EVENT_CREATED
face was created
@ FACE_EVENT_UP
face went UP (from DOWN state)
@ FACE_EVENT_DESTROYED
face was destroyed
Contains classes and functions related to the NFD Management protocol.
std::istream & operator>>(std::istream &is, RouteOrigin &routeOrigin)
Extract RouteOrigin from stream.
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
ostream_joiner< std::decay_t< DelimT >, CharT, Traits > make_ostream_joiner(std::basic_ostream< CharT, Traits > &os, DelimT &&delimiter)
Backport of ostream_joiner from the Library Fundamentals v2 TS.