blob: 01e8c2ba2518df8b53a48904d057a1a33f515b0e [file] [log] [blame]
Alexander Afanasyev0866f512014-08-11 13:25:09 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Eric Newberry251e5f72017-07-09 21:31:25 -04002/*
Junxiao Shi22f85682018-01-22 19:23:22 +00003 * Copyright (c) 2013-2018 Regents of the University of California.
Alexander Afanasyev0866f512014-08-11 13:25:09 -07004 *
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_ENCODING_NFD_CONSTANTS_HPP
23#define NDN_ENCODING_NFD_CONSTANTS_HPP
24
Junxiao Shi4c53b0f2014-10-26 20:35:46 -070025#include "../common.hpp"
26
Alexander Afanasyev0866f512014-08-11 13:25:09 -070027namespace ndn {
28namespace nfd {
29
Davide Pesaventof8503d22017-02-17 01:19:10 -050030const uint64_t INVALID_FACE_ID = 0;
Alexander Afanasyev0866f512014-08-11 13:25:09 -070031
Junxiao Shi65f1a712014-11-20 14:59:36 -070032/** \ingroup management
Alexander Afanasyev0866f512014-08-11 13:25:09 -070033 */
Junxiao Shi18ef4de2015-10-17 16:58:23 +000034enum FaceScope : uint8_t {
Davide Pesaventoe55589c2017-02-20 03:02:51 -050035 FACE_SCOPE_NONE = std::numeric_limits<uint8_t>::max(),
36 FACE_SCOPE_NON_LOCAL = 0, ///< face is non-local
37 FACE_SCOPE_LOCAL = 1, ///< face is local
Junxiao Shi65f1a712014-11-20 14:59:36 -070038};
39
40std::ostream&
41operator<<(std::ostream& os, FaceScope faceScope);
42
43/** \ingroup management
44 */
Junxiao Shi18ef4de2015-10-17 16:58:23 +000045enum FacePersistency : uint8_t {
Davide Pesaventoe55589c2017-02-20 03:02:51 -050046 FACE_PERSISTENCY_NONE = std::numeric_limits<uint8_t>::max(),
47 FACE_PERSISTENCY_PERSISTENT = 0, ///< face is persistent
48 FACE_PERSISTENCY_ON_DEMAND = 1, ///< face is on-demand
49 FACE_PERSISTENCY_PERMANENT = 2, ///< face is permanent
Junxiao Shi65f1a712014-11-20 14:59:36 -070050};
51
52std::ostream&
53operator<<(std::ostream& os, FacePersistency facePersistency);
54
55/** \ingroup management
56 */
Junxiao Shi18ef4de2015-10-17 16:58:23 +000057enum LinkType : uint8_t {
Davide Pesaventoe55589c2017-02-20 03:02:51 -050058 LINK_TYPE_NONE = std::numeric_limits<uint8_t>::max(),
59 LINK_TYPE_POINT_TO_POINT = 0, ///< link is point-to-point
60 LINK_TYPE_MULTI_ACCESS = 1, ///< link is multi-access
Teng Liangb4ecadc2017-03-25 10:55:40 -050061 LINK_TYPE_AD_HOC = 2, ///< link is ad hoc
Junxiao Shi65f1a712014-11-20 14:59:36 -070062};
63
64std::ostream&
65operator<<(std::ostream& os, LinkType linkType);
66
67/** \ingroup management
68 */
Davide Pesaventoe55589c2017-02-20 03:02:51 -050069enum FaceFlagBit {
Eric Newberry07d05c92018-01-22 16:08:01 -070070 BIT_LOCAL_FIELDS_ENABLED = 0, ///< whether local fields are enabled on a face
71 BIT_LP_RELIABILITY_ENABLED = 1, ///< whether the link reliability feature is enabled on a face
72 BIT_CONGESTION_MARKING_ENABLED = 2, ///< whether congestion detection and marking is enabled on a face
Davide Pesaventoe55589c2017-02-20 03:02:51 -050073};
74
75/** \ingroup management
76 */
77enum FaceEventKind : uint8_t {
78 FACE_EVENT_NONE = 0,
79 FACE_EVENT_CREATED = 1, ///< face was created
80 FACE_EVENT_DESTROYED = 2, ///< face was destroyed
81 FACE_EVENT_UP = 3, ///< face went UP (from DOWN state)
82 FACE_EVENT_DOWN = 4, ///< face went DOWN (from UP state)
83};
84
85std::ostream&
86operator<<(std::ostream& os, FaceEventKind faceEventKind);
87
88/** \ingroup management
Junxiao Shi22f85682018-01-22 19:23:22 +000089 * \brief CS enablement flags
90 * \sa https://redmine.named-data.net/projects/nfd/wiki/CsMgmt#Update-config
91 */
92enum CsFlagBit {
93 BIT_CS_ENABLE_ADMIT = 0, ///< enables the CS to admit new Data
94 BIT_CS_ENABLE_SERVE = 1, ///< enables the CS to satisfy Interests using cached Data
95};
96
97/** \ingroup management
Davide Pesaventoe55589c2017-02-20 03:02:51 -050098 */
Junxiao Shi18ef4de2015-10-17 16:58:23 +000099enum RouteOrigin : uint16_t {
100 ROUTE_ORIGIN_NONE = std::numeric_limits<uint16_t>::max(),
Alexander Afanasyev0866f512014-08-11 13:25:09 -0700101 ROUTE_ORIGIN_APP = 0,
102 ROUTE_ORIGIN_AUTOREG = 64,
103 ROUTE_ORIGIN_CLIENT = 65,
104 ROUTE_ORIGIN_AUTOCONF = 66,
105 ROUTE_ORIGIN_NLSR = 128,
Davide Pesaventoe55589c2017-02-20 03:02:51 -0500106 ROUTE_ORIGIN_STATIC = 255,
Junxiao Shi65f1a712014-11-20 14:59:36 -0700107};
Alexander Afanasyev0866f512014-08-11 13:25:09 -0700108
Junxiao Shi6336c5f2017-04-04 22:16:03 +0000109/** \brief extract RouteOrigin from stream
110 * \post if the first token in \p contains a valid RouteOrigin as string or numeric value, it is
111 * extracted into \p routeOrigin ; otherwise, \p routeOrigin is set to \p ROUTE_ORIGIN_NONE ,
112 * and failbit is set on \p is
113 */
114std::istream&
115operator>>(std::istream& is, RouteOrigin& routeOrigin);
116
Junxiao Shi18ef4de2015-10-17 16:58:23 +0000117std::ostream&
118operator<<(std::ostream& os, RouteOrigin routeOrigin);
119
Junxiao Shi65f1a712014-11-20 14:59:36 -0700120/** \ingroup management
121 */
Davide Pesavento56bd3ee2017-02-26 16:05:16 -0500122enum RouteFlags : uint64_t {
Junxiao Shi18ef4de2015-10-17 16:58:23 +0000123 ROUTE_FLAGS_NONE = 0,
Alexander Afanasyev0866f512014-08-11 13:25:09 -0700124 ROUTE_FLAG_CHILD_INHERIT = 1,
Davide Pesaventoe55589c2017-02-20 03:02:51 -0500125 ROUTE_FLAG_CAPTURE = 2,
Alexander Afanasyev0866f512014-08-11 13:25:09 -0700126};
127
Junxiao Shi18ef4de2015-10-17 16:58:23 +0000128std::ostream&
129operator<<(std::ostream& os, RouteFlags routeFlags);
130
Alexander Afanasyev0866f512014-08-11 13:25:09 -0700131} // namespace nfd
132} // namespace ndn
133
134#endif // NDN_ENCODING_NFD_CONSTANTS_HPP