NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
face-query-filter.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
22 #ifndef NDN_MGMT_NFD_FACE_QUERY_FILTER_HPP
23 #define NDN_MGMT_NFD_FACE_QUERY_FILTER_HPP
24 
25 #include "../../encoding/block.hpp"
26 #include "../../encoding/nfd-constants.hpp"
27 
28 namespace ndn {
29 namespace nfd {
30 
37 {
38 public:
39  class Error : public tlv::Error
40  {
41  public:
42  explicit
43  Error(const std::string& what)
44  : tlv::Error(what)
45  {
46  }
47  };
48 
50 
51  explicit
52  FaceQueryFilter(const Block& block);
53 
56  template<encoding::Tag TAG>
57  size_t
58  wireEncode(EncodingImpl<TAG>& encoder) const;
59 
62  const Block&
63  wireEncode() const;
64 
67  void
68  wireDecode(const Block& wire);
69 
70 public: // getters & setters
71 
72  bool
73  hasFaceId() const
74  {
75  return m_hasFaceId;
76  }
77 
78  uint64_t
79  getFaceId() const
80  {
81  BOOST_ASSERT(this->hasFaceId());
82  return m_faceId;
83  }
84 
86  setFaceId(uint64_t faceId);
87 
89  unsetFaceId();
90 
91  bool
92  hasUriScheme() const
93  {
94  return m_hasUriScheme;
95  }
96 
97  const std::string&
98  getUriScheme() const
99  {
100  BOOST_ASSERT(this->hasUriScheme());
101  return m_uriScheme;
102  }
103 
105  setUriScheme(const std::string& uriScheme);
106 
108  unsetUriScheme();
109 
110  bool
111  hasRemoteUri() const
112  {
113  return m_hasRemoteUri;
114  }
115 
116  const std::string&
117  getRemoteUri() const
118  {
119  BOOST_ASSERT(this->hasRemoteUri());
120  return m_remoteUri;
121  }
122 
124  setRemoteUri(const std::string& remoteUri);
125 
127  unsetRemoteUri();
128 
129  bool
130  hasLocalUri() const
131  {
132  return m_hasLocalUri;
133  }
134 
135  const std::string&
136  getLocalUri() const
137  {
138  BOOST_ASSERT(this->hasLocalUri());
139  return m_localUri;
140  }
141 
143  setLocalUri(const std::string& localUri);
144 
146  unsetLocalUri();
147 
148  bool
149  hasFaceScope() const
150  {
151  return m_hasFaceScope;
152  }
153 
154  FaceScope
155  getFaceScope() const
156  {
157  BOOST_ASSERT(this->hasFaceScope());
158  return m_faceScope;
159  }
160 
162  setFaceScope(FaceScope faceScope);
163 
165  unsetFaceScope();
166 
167  bool
169  {
170  return m_hasFacePersistency;
171  }
172 
175  {
176  BOOST_ASSERT(this->hasFacePersistency());
177  return m_facePersistency;
178  }
179 
181  setFacePersistency(FacePersistency facePersistency);
182 
185 
186  bool
187  hasLinkType() const
188  {
189  return m_hasLinkType;
190  }
191 
192  LinkType
193  getLinkType() const
194  {
195  BOOST_ASSERT(this->hasLinkType());
196  return m_linkType;
197  }
198 
200  setLinkType(LinkType linkType);
201 
203  unsetLinkType();
204 
205 private:
206  uint64_t m_faceId;
207  std::string m_uriScheme;
208  std::string m_remoteUri;
209  std::string m_localUri;
210  FaceScope m_faceScope;
211  FacePersistency m_facePersistency;
212  LinkType m_linkType;
213 
214  bool m_hasFaceId;
215  bool m_hasUriScheme;
216  bool m_hasRemoteUri;
217  bool m_hasLocalUri;
218  bool m_hasFaceScope;
219  bool m_hasFacePersistency;
220  bool m_hasLinkType;
221 
222  mutable Block m_wire;
223 };
224 
225 std::ostream&
226 operator<<(std::ostream& os, const FaceQueryFilter& filter);
227 
228 } // namespace nfd
229 } // namespace ndn
230 
231 #endif // NDN_MGMT_NFD_FACE_QUERY_FILTER_HPP
Copyright (c) 2011-2015 Regents of the University of California.
FaceQueryFilter & unsetLocalUri()
const std::string & getLocalUri() const
Class representing a wire element of NDN-TLV packet format.
Definition: block.hpp:43
const std::string & getRemoteUri() const
FaceQueryFilter & unsetFaceScope()
FaceQueryFilter & setLocalUri(const std::string &localUri)
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
const Block & wireEncode() const
encode FaceQueryFilter
FaceQueryFilter & setFaceScope(FaceScope faceScope)
FaceQueryFilter & unsetFaceId()
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
FaceQueryFilter & setUriScheme(const std::string &uriScheme)
FaceQueryFilter & unsetFacePersistency()
represents Face Query Filter
FaceQueryFilter & unsetUriScheme()
FaceQueryFilter & unsetRemoteUri()
FaceQueryFilter & setRemoteUri(const std::string &remoteUri)
Error(const std::string &what)
FaceQueryFilter & setFaceId(uint64_t faceId)
const std::string & getUriScheme() const
FaceQueryFilter & setLinkType(LinkType linkType)
FaceQueryFilter & setFacePersistency(FacePersistency facePersistency)
FacePersistency getFacePersistency() const
void wireDecode(const Block &wire)
decode FaceQueryFilter
represents an error in TLV encoding or decoding
Definition: tlv.hpp:50
FaceQueryFilter & unsetLinkType()