name-lite.hpp
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
22 #ifndef NDN_NAME_LITE_HPP
23 #define NDN_NAME_LITE_HPP
24 
25 #include "../c/errors.h"
26 #include "util/blob-lite.hpp"
27 #include "../c/name-types.h"
28 
29 namespace ndn {
30 
34 class NameLite : private ndn_Name {
35 public:
39  class Component : private ndn_NameComponent {
40  public:
44  Component();
45 
51  Component(const uint8_t* value, size_t valueLength);
52 
58  Component(const BlobLite& value);
59 
60  const BlobLite&
61  getValue() const { return BlobLite::upCast(value); }
62 
67  uint64_t
68  toNumber() const;
69 
78  ndn_Error
79  toNumberWithMarker(uint8_t marker, uint64_t& result) const;
80 
90  ndn_Error
92  (const uint8_t* prefix, size_t prefixLength, uint64_t& result) const;
93 
100  bool
101  hasPrefix(const uint8_t* prefix, size_t prefixLength) const;
102 
111  ndn_Error
112  toSegment(uint64_t& result) const;
113 
122  ndn_Error
123  toSegmentOffset(uint64_t& result) const;
124 
134  ndn_Error
135  toVersion(uint64_t& result) const;
136 
146  ndn_Error
147  toTimestamp(uint64_t& result) const;
148 
157  ndn_Error
158  toSequenceNumber(uint64_t& result) const;
159 
167  int compare(const Component& other) const;
168 
174  static Component&
175  upCast(ndn_NameComponent& component) { return *(Component*)&component; }
176 
177  static const Component&
178  upCast(const ndn_NameComponent& component) { return *(Component*)&component; }
179  };
180 
190 
197  const Component&
198  get(int i) const
199  {
200  // TODO: Range check.
201  if (i >= 0)
202  return Component::upCast(components[i]);
203  else
204  // Negative index.
205  return Component::upCast(components[nComponents - (-i)]);
206  }
207 
212  size_t
213  size() const { return nComponents; }
214 
222  bool
223  equals(const NameLite& name);
224 
232  bool
233  match(const NameLite& name) const;
234 
238  void
239  clear();
240 
249  ndn_Error
250  append(const uint8_t* value, size_t valueLength);
251 
259  ndn_Error
260  append(const BlobLite& value) { return append(value.buf(), value.size()); }
261 
269  ndn_Error
270  append(const NameLite::Component& component)
271  {
272  return append(component.getValue().buf(), component.getValue().size());
273  }
274 
282  ndn_Error
283  append(const char *value);
284 
298  ndn_Error
299  appendSegment(uint64_t segment, uint8_t* buffer, size_t bufferLength);
300 
314  ndn_Error
316  (uint64_t segmentOffset, uint8_t* buffer, size_t bufferLength);
317 
332  ndn_Error
333  appendVersion(uint64_t version, uint8_t* buffer, size_t bufferLength);
334 
349  ndn_Error
350  appendTimestamp(uint64_t timestamp, uint8_t* buffer, size_t bufferLength);
351 
365  ndn_Error
367  (uint64_t sequenceNumber, uint8_t* buffer, size_t bufferLength);
368 
375  ndn_Error
376  set(const NameLite& other);
377 
383  static NameLite&
384  upCast(ndn_Name& name) { return *(NameLite*)&name; }
385 
386  static const NameLite&
387  upCast(const ndn_Name& name) { return *(NameLite*)&name; }
388 
389 private:
390  // Declare friends who can downcast to the private base.
391  friend class Tlv0_1_1WireFormatLite;
392 
397  NameLite(NameLite& other);
398  NameLite(const NameLite& other);
399 
404  NameLite& operator=(const NameLite& other);
405 };
406 
407 }
408 
409 #endif
ndn_Error append(const uint8_t *value, size_t valueLength)
Append a component to this name with the bytes in the given buffer.
Definition: name-lite.cpp:125
size_t size() const
Return size given to the constructor.
Definition: blob-lite.hpp:61
ndn_Error toTimestamp(uint64_t &result) const
Interpret this name component as a timestamp according to NDN naming conventions for "Timestamp" (mar...
Definition: name-lite.cpp:87
Copyright (C) 2013-2016 Regents of the University of California.
Definition: common.hpp:35
int compare(const Component &other) const
Compare this component to the other component using NDN component ordering.
Definition: name-lite.cpp:99
ndn_Error append(const NameLite::Component &component)
Append a component to this name with the bytes in the given component.
Definition: name-lite.hpp:270
ndn_Error appendSegment(uint64_t segment, uint8_t *buffer, size_t bufferLength)
Append a component with the encoded segment number according to NDN naming conventions for "Segment n...
Definition: name-lite.cpp:134
uint64_t toNumber() const
Interpret the name component as a network-ordered number and return an integer.
Definition: name-lite.cpp:43
A NameLite holds an array of NameLite::Component.
Definition: name-lite.hpp:34
ndn_Error toNumberWithMarker(uint8_t marker, uint64_t &result) const
Interpret the name component as a network-ordered number with a marker and return an integer...
Definition: name-lite.cpp:49
bool match(const NameLite &name) const
Check if the N components of this name are the same as the first N components of the given name...
Definition: name-lite.cpp:116
ndn_Error appendSegmentOffset(uint64_t segmentOffset, uint8_t *buffer, size_t bufferLength)
Append a component with the encoded segment byte offset according to NDN naming conventions for segme...
Definition: name-lite.cpp:145
struct ndn_NameComponent * components
pointer to the array of components.
Definition: name-types.h:41
static BlobLite & upCast(ndn_Blob &blob)
Upcast the reference to the ndn_Blob struct to a BlobLite.
Definition: blob-lite.hpp:69
ndn_Error toNumberWithPrefix(const uint8_t *prefix, size_t prefixLength, uint64_t &result) const
Interpret the name component as a network-ordered number with a prefix and return an integer...
Definition: name-lite.cpp:56
ndn_Error set(const NameLite &other)
Set this name to have the values from the other name.
Definition: name-lite.cpp:186
size_t nComponents
the number of components in the name
Definition: name-types.h:43
Copyright (C) 2015-2016 Regents of the University of California.
Definition: name-types.h:33
struct ndn_Blob value
A Blob with a pointer to the pre-allocated buffer for the component value.
Definition: name-types.h:34
void clear()
Clear all the components.
Definition: name-lite.cpp:122
An ndn_Name holds an array of ndn_NameComponent.
Definition: name-types.h:40
A NameLite::Component holds a pointer to the component value.
Definition: name-lite.hpp:39
A BlobLite holds a pointer to an immutable pre-allocated buffer and its length This is like a JavaScr...
Definition: blob-lite.hpp:37
bool hasPrefix(const uint8_t *prefix, size_t prefixLength) const
Check if this name component begins with the given prefix.
Definition: name-lite.cpp:63
ndn_Error append(const BlobLite &value)
Append a component to this name with the bytes in the given blob.
Definition: name-lite.hpp:260
static Component & upCast(ndn_NameComponent &component)
Upcast the reference to the ndn_NameComponent struct to a NameLite::Component.
Definition: name-lite.hpp:175
const uint8_t * buf() const
Return buf given to the constructor.
Definition: blob-lite.hpp:55
size_t maxComponents
the number of elements in the allocated components array
Definition: name-types.h:42
NameLite(ndn_NameComponent *components, size_t maxComponents)
Create a NameLite to use the components array.
Definition: name-lite.cpp:104
static NameLite & upCast(ndn_Name &name)
Upcast the reference to the ndn_Name struct to a NameLite.
Definition: name-lite.hpp:384
ndn_Error appendTimestamp(uint64_t timestamp, uint8_t *buffer, size_t bufferLength)
Append a component with the encoded timestamp according to NDN naming conventions for "Timestamp" (ma...
Definition: name-lite.cpp:165
ndn_Error toSegmentOffset(uint64_t &result) const
Interpret this name component as a segment byte offset according to NDN naming conventions for segmen...
Definition: name-lite.cpp:75
bool equals(const NameLite &name)
Check if this name has the same component count and components as the given name. ...
Definition: name-lite.cpp:110
size_t size() const
Get the number of components.
Definition: name-lite.hpp:213
ndn_Error appendVersion(uint64_t version, uint8_t *buffer, size_t bufferLength)
Append a component with the encoded version number according to NDN naming conventions for "Versionin...
Definition: name-lite.cpp:155
ndn_Error toSequenceNumber(uint64_t &result) const
Interpret this name component as a sequence number according to NDN naming conventions for "Sequencin...
Definition: name-lite.cpp:93
ndn_Error appendSequenceNumber(uint64_t sequenceNumber, uint8_t *buffer, size_t bufferLength)
Append a component with the encoded sequence number according to NDN naming conventions for "Sequenci...
Definition: name-lite.cpp:176
Component()
Create a NameLite::Component of zero size.
Definition: name-lite.cpp:27
ndn_Error toVersion(uint64_t &result) const
Interpret this name component as a version number according to NDN naming conventions for "Versioning...
Definition: name-lite.cpp:81
ndn_Error toSegment(uint64_t &result) const
Interpret this name component as a segment number according to NDN naming conventions for "Segment nu...
Definition: name-lite.cpp:69