blob: 24ef36e330806c2e549871c2b5702ade560f3da3 [file] [log] [blame]
Jeff Thompson47eecfc2013-07-07 22:56:46 -07001/**
2 * @author: Jeff Thompson
3 * See COPYING for copyright and distribution information.
Jeff Thompsonb7f95562013-07-03 18:36:42 -07004 */
5
6#ifndef NDN_INTEREST_HPP
7#define NDN_INTEREST_HPP
8
Jeff Thompsonb7f95562013-07-03 18:36:42 -07009#include "Name.hpp"
Jeff Thompson8238d002013-07-10 11:56:49 -070010#include "PublisherPublicKeyDigest.hpp"
Jeff Thompsonb7f95562013-07-03 18:36:42 -070011#include "c/Interest.h"
12
13namespace ndn {
Jeff Thompsonfe556862013-07-09 13:52:55 -070014
Jeff Thompson8238d002013-07-10 11:56:49 -070015/**
16 * An ExcludeEntry holds an ndn_ExcludeType, and if it is a COMPONENT, it holds the component value.
17 */
Jeff Thompsonfe556862013-07-09 13:52:55 -070018class ExcludeEntry {
19public:
20 /**
21 * Create an ExcludeEntry of type ndn_Exclude_ANY
22 */
23 ExcludeEntry()
24 : type_(ndn_Exclude_ANY)
25 {
26 }
27
28 /**
29 * Create an ExcludeEntry of type ndn_Exclude_COMPONENT
30 */
31 ExcludeEntry(unsigned char *component, unsigned int componentLen)
32 : type_(ndn_Exclude_COMPONENT), component_(component, component + componentLen)
33 {
34 }
35
36 /**
37 * Set the type in the excludeEntryStruct and to point to this component, without copying any memory.
38 * WARNING: The resulting pointer in excludeEntryStruct is invalid after a further use of this object which could reallocate memory.
Jeff Thompson8238d002013-07-10 11:56:49 -070039 * @param excludeEntryStruct the C ndn_NameComponent struct to receive the pointer
Jeff Thompsonfe556862013-07-09 13:52:55 -070040 */
41 void get(struct ndn_ExcludeEntry &excludeEntryStruct) const
42 {
43 excludeEntryStruct.type = type_;
44 if (type_ == ndn_Exclude_COMPONENT) {
45 excludeEntryStruct.componentLength = component_.size();
46 excludeEntryStruct.component = (unsigned char *)&component_[0];
47 }
48 }
49
50 ndn_ExcludeType getType() const { return type_; }
51
52 const std::vector<unsigned char> &getComponent() const { return component_; }
53
54private:
55 ndn_ExcludeType type_;
56 std::vector<unsigned char> component_; /**< only used if type_ is ndn_Exclude_COMPONENT */
57};
58
Jeff Thompson8238d002013-07-10 11:56:49 -070059/**
60 * An Exclude holds a vector of ExcludeEntry.
61 */
Jeff Thompsonfe556862013-07-09 13:52:55 -070062class Exclude {
63public:
64 /**
65 * Create a new Exclude with no entries.
66 */
67 Exclude() {
68 }
69
70 unsigned int getEntryCount() const {
71 return entries_.size();
72 }
73
74 const ExcludeEntry &getEntry(unsigned int i) const { return entries_[i]; }
75
76 /**
Jeff Thompson8238d002013-07-10 11:56:49 -070077 * Set the excludeStruct to point to the entries in this Exclude, without copying any memory.
Jeff Thompsonfe556862013-07-09 13:52:55 -070078 * WARNING: The resulting pointers in excludeStruct are invalid after a further use of this object which could reallocate memory.
Jeff Thompson8238d002013-07-10 11:56:49 -070079 * @param excludeStruct a C ndn_Exclude struct where the entries array is already allocated
Jeff Thompsonfe556862013-07-09 13:52:55 -070080 */
81 void get(struct ndn_Exclude &excludeStruct) const;
82
83 /**
Jeff Thompson8238d002013-07-10 11:56:49 -070084 * Clear this Exclude, and set the entries by copying from the ndn_Exclude struct.
Jeff Thompsonfe556862013-07-09 13:52:55 -070085 * @param excludeStruct a C ndn_Exclude struct
86 */
Jeff Thompsondd3d2292013-07-10 11:59:44 -070087 void set(const struct ndn_Exclude &excludeStruct);
Jeff Thompsonfe556862013-07-09 13:52:55 -070088
89 /**
90 * Add a new entry of type ndn_Exclude_ANY
91 */
92 void addAny()
93 {
94 entries_.push_back(ExcludeEntry());
95 }
96
97 /**
98 * Add a new entry of type ndn_Exclude_COMPONENT, copying from component of length compnentLength
99 */
100 void addComponent(unsigned char *component, unsigned int componentLen)
101 {
102 entries_.push_back(ExcludeEntry(component, componentLen));
103 }
104
105 /**
106 * Clear all the entries.
107 */
108 void clear() {
109 entries_.clear();
110 }
111
112private:
113 std::vector<ExcludeEntry> entries_;
114};
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700115
Jeff Thompson8238d002013-07-10 11:56:49 -0700116/**
117 * An Interest holds a Name and other fields for an interest.
118 */
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700119class Interest {
120public:
Jeff Thompson34238652013-07-10 18:25:00 -0700121 Interest()
122 {
Jeff Thompsonc0486c12013-07-16 14:36:16 -0700123 construct();
124 }
125
126 Interest(const Name &name)
Jeff Thompsonf59a87a2013-07-31 16:55:41 -0700127 : name_(name)
Jeff Thompsonc0486c12013-07-16 14:36:16 -0700128 {
129 name_ = name;
130 construct();
Jeff Thompson34238652013-07-10 18:25:00 -0700131 }
132
Jeff Thompsonf59a87a2013-07-31 16:55:41 -0700133 Interest(const Name &name, int minSuffixComponents, int maxSuffixComponents,
134 const PublisherPublicKeyDigest &publisherPublicKeyDigest, const Exclude &exclude, int childSelector, int answerOriginKind,
135 int scope, double interestLifetimeMilliseconds, const std::vector<unsigned char> &nonce)
136 : name_(name), minSuffixComponents_(minSuffixComponents), maxSuffixComponents_(maxSuffixComponents),
137 publisherPublicKeyDigest_(publisherPublicKeyDigest), exclude_(exclude), childSelector_(childSelector),
138 answerOriginKind_(answerOriginKind), scope_(scope), interestLifetimeMilliseconds_(interestLifetimeMilliseconds),
139 nonce_(nonce)
140 {
141 }
142
Jeff Thompsonb0979fd2013-07-30 15:48:21 -0700143 ptr_lib::shared_ptr<std::vector<unsigned char> > encode(WireFormat &wireFormat) const
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700144 {
Jeff Thompsonb0979fd2013-07-30 15:48:21 -0700145 return wireFormat.encodeInterest(*this);
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700146 }
Jeff Thompsonb0979fd2013-07-30 15:48:21 -0700147 ptr_lib::shared_ptr<std::vector<unsigned char> > encode() const
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700148 {
Jeff Thompsonb915b1d2013-07-31 10:53:13 -0700149 return encode(BinaryXmlWireFormat::getInstance());
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700150 }
151 void decode(const unsigned char *input, unsigned int inputLength, WireFormat &wireFormat)
152 {
153 wireFormat.decodeInterest(*this, input, inputLength);
154 }
155 void decode(const unsigned char *input, unsigned int inputLength)
156 {
Jeff Thompsonb915b1d2013-07-31 10:53:13 -0700157 decode(input, inputLength, BinaryXmlWireFormat::getInstance());
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700158 }
159 void decode(const std::vector<unsigned char> &input, WireFormat &wireFormat)
160 {
161 decode(&input[0], input.size(), wireFormat);
162 }
163 void decode(const std::vector<unsigned char> &input)
164 {
165 decode(&input[0], input.size());
166 }
Jeff Thompsond9e278c2013-07-08 15:20:13 -0700167
168 /**
169 * Set the interestStruct to point to the components in this interest, without copying any memory.
170 * WARNING: The resulting pointers in interestStruct are invalid after a further use of this object which could reallocate memory.
171 * @param interestStruct a C ndn_Interest struct where the name components array is already allocated.
172 */
Jeff Thompsond345a5b2013-07-08 16:18:23 -0700173 void get(struct ndn_Interest &interestStruct) const;
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700174
Jeff Thompson12c27762013-07-09 15:05:11 -0700175 Name &getName() { return name_; }
Jeff Thompsond345a5b2013-07-08 16:18:23 -0700176 const Name &getName() const { return name_; }
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700177
Jeff Thompsond345a5b2013-07-08 16:18:23 -0700178 int getMinSuffixComponents() const { return minSuffixComponents_; }
179
180 int getMaxSuffixComponents() const { return maxSuffixComponents_; }
Jeff Thompson0a681722013-07-08 16:21:54 -0700181
Jeff Thompson8238d002013-07-10 11:56:49 -0700182 PublisherPublicKeyDigest &getPublisherPublicKeyDigest() { return publisherPublicKeyDigest_; }
183 const PublisherPublicKeyDigest &getPublisherPublicKeyDigest() const { return publisherPublicKeyDigest_; }
Jeff Thompson0a681722013-07-08 16:21:54 -0700184
Jeff Thompson12c27762013-07-09 15:05:11 -0700185 Exclude &getExclude() { return exclude_; }
Jeff Thompsonfe556862013-07-09 13:52:55 -0700186 const Exclude &getExclude() const { return exclude_; }
Jeff Thompson0a681722013-07-08 16:21:54 -0700187
188 int getChildSelector() const { return childSelector_; }
189
190 int getAnswerOriginKind() const { return answerOriginKind_; }
191
192 int getScope() const { return scope_; }
Jeff Thompsond345a5b2013-07-08 16:18:23 -0700193
Jeff Thompson5a5e8b72013-07-11 14:28:03 -0700194 double getInterestLifetimeMilliseconds() const { return interestLifetimeMilliseconds_; }
Jeff Thompson0a681722013-07-08 16:21:54 -0700195
196 const std::vector<unsigned char> getNonce() const { return nonce_; }
Jeff Thompson22552902013-07-07 21:26:20 -0700197
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700198 /**
199 * Clear this interest, and set the values by copying from the interest struct.
200 * @param interestStruct a C ndn_Interest struct
201 */
Jeff Thompsondd3d2292013-07-10 11:59:44 -0700202 void set(const struct ndn_Interest &interestStruct);
Jeff Thompsoneb316a82013-07-09 15:11:17 -0700203
204 void setMinSuffixComponents(int value) { minSuffixComponents_ = value; }
205
206 void setMaxSuffixComponents(int value) { maxSuffixComponents_ = value; }
207
Jeff Thompsoneb316a82013-07-09 15:11:17 -0700208 void setChildSelector(int value) { childSelector_ = value; }
209
210 void setAnswerOriginKind(int value) { answerOriginKind_ = value; }
211
212 void setScope(int value) { scope_ = value; }
213
Jeff Thompson5a5e8b72013-07-11 14:28:03 -0700214 void setInterestLifetimeMilliseconds(double value) { interestLifetimeMilliseconds_ = value; }
Jeff Thompsoneb316a82013-07-09 15:11:17 -0700215
216 void setNonce(const std::vector<unsigned char> &value) { nonce_ = value; }
217
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700218private:
Jeff Thompsonc0486c12013-07-16 14:36:16 -0700219 void construct()
220 {
221 minSuffixComponents_ = -1;
222 maxSuffixComponents_ = -1;
223 childSelector_ = -1;
224 answerOriginKind_ = -1;
225 scope_ = -1;
226 interestLifetimeMilliseconds_ = -1.0;
227 }
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700228
229 Name name_;
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700230 int minSuffixComponents_;
Jeff Thompsonf2e5e282013-07-08 15:26:16 -0700231 int maxSuffixComponents_;
Jeff Thompson8238d002013-07-10 11:56:49 -0700232 PublisherPublicKeyDigest publisherPublicKeyDigest_;
Jeff Thompsonfe556862013-07-09 13:52:55 -0700233 Exclude exclude_;
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700234 int childSelector_;
235 int answerOriginKind_;
236 int scope_;
Jeff Thompson5a5e8b72013-07-11 14:28:03 -0700237 double interestLifetimeMilliseconds_;
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700238 std::vector<unsigned char> nonce_;
239};
240
241}
242
243#endif