nfd-constants.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2021 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 
22 #ifndef NDN_CXX_ENCODING_NFD_CONSTANTS_HPP
23 #define NDN_CXX_ENCODING_NFD_CONSTANTS_HPP
24 
26 
27 namespace ndn {
28 namespace nfd {
29 
30 const uint64_t INVALID_FACE_ID = 0;
31 
34 enum FaceScope : uint8_t {
35  FACE_SCOPE_NONE = std::numeric_limits<uint8_t>::max(),
38 };
39 
40 std::ostream&
41 operator<<(std::ostream& os, FaceScope faceScope);
42 
45 enum FacePersistency : uint8_t {
46  FACE_PERSISTENCY_NONE = std::numeric_limits<uint8_t>::max(),
50 };
51 
52 std::ostream&
53 operator<<(std::ostream& os, FacePersistency facePersistency);
54 
57 enum LinkType : uint8_t {
58  LINK_TYPE_NONE = std::numeric_limits<uint8_t>::max(),
62 };
63 
64 std::ostream&
65 operator<<(std::ostream& os, LinkType linkType);
66 
73 };
74 
77 enum FaceEventKind : uint8_t {
83 };
84 
85 std::ostream&
86 operator<<(std::ostream& os, FaceEventKind faceEventKind);
87 
92 enum CsFlagBit {
95 };
96 
99 enum RouteOrigin : uint16_t {
100  ROUTE_ORIGIN_NONE = std::numeric_limits<uint16_t>::max(),
108 };
109 
115 std::istream&
116 operator>>(std::istream& is, RouteOrigin& routeOrigin);
117 
118 std::ostream&
119 operator<<(std::ostream& os, RouteOrigin routeOrigin);
120 
123 enum RouteFlags : uint64_t {
127 };
128 
129 std::ostream&
130 operator<<(std::ostream& os, RouteFlags routeFlags);
131 
132 } // namespace nfd
133 } // namespace ndn
134 
135 #endif // NDN_CXX_ENCODING_NFD_CONSTANTS_HPP
Common includes and macros used throughout the library.
CsFlagBit
CS enablement flags.
@ 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
@ BIT_LOCAL_FIELDS_ENABLED
whether local fields are enabled on a face
@ BIT_CONGESTION_MARKING_ENABLED
whether congestion detection and marking is enabled on a face
@ BIT_LP_RELIABILITY_ENABLED
whether the link reliability feature is enabled on a face
@ 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
@ BIT_CS_ENABLE_ADMIT
enables the CS to admit new Data
@ BIT_CS_ENABLE_SERVE
enables the CS to satisfy Interests using cached Data
std::istream & operator>>(std::istream &is, RouteOrigin &routeOrigin)
extract RouteOrigin from stream
const uint64_t INVALID_FACE_ID
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
Definition: data.cpp:25