blob: d25253ff5696824d07d2e957f753a4b9c4ffdde9 [file] [log] [blame]
Jeff Thompson25b4e612013-10-10 16:03:24 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Jeff Thompson5cae5e52013-07-10 19:41:20 -07002/**
Jeff Thompson7687dc02013-09-13 11:54:07 -07003 * Copyright (C) 2013 Regents of the University of California.
4 * @author: Jeff Thompson <jefft0@remap.ucla.edu>
Jeff Thompson5cae5e52013-07-10 19:41:20 -07005 * See COPYING for copyright and distribution information.
6 */
7
Jeff Thompson56ec9e22013-08-02 11:34:07 -07008#ifndef NDN_DATA_HPP
Jeff Thompsona0d18c92013-08-06 13:55:32 -07009#define NDN_DATA_HPP
Jeff Thompson5cae5e52013-07-10 19:41:20 -070010
Jeff Thompson46bd45f2013-08-08 16:46:41 -070011#include "common.hpp"
Jeff Thompson53412192013-08-06 13:35:50 -070012#include "name.hpp"
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -080013#include "encoding/block.hpp"
Jeff Thompson25b4e612013-10-10 16:03:24 -070014
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080015#include "signature.hpp"
16#include "meta-info.hpp"
17#include "key-locator.hpp"
Jeff Thompson5cae5e52013-07-10 19:41:20 -070018
19namespace ndn {
Jeff Thompson5cae5e52013-07-10 19:41:20 -070020
Jeff Thompson56ec9e22013-08-02 11:34:07 -070021class Data {
Jeff Thompson5cae5e52013-07-10 19:41:20 -070022public:
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080023 struct Error : public std::runtime_error { Error(const std::string &what) : std::runtime_error(what) {} };
24
Jeff Thompson20af0732013-09-12 17:01:45 -070025 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080026 * @brief Create an empty Data object
Jeff Thompson20af0732013-09-12 17:01:45 -070027 */
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080028 inline
29 Data();
30
Jeff Thompson20af0732013-09-12 17:01:45 -070031 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080032 * @brief Create a new Data object with the given name
Jeff Thompson20af0732013-09-12 17:01:45 -070033 * @param name A reference to the name which is copied.
34 */
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080035 inline
36 Data(const Name& name);
Jeff Thompson25bfdca2013-10-16 17:05:41 -070037
38 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080039 * @brief The virtual destructor.
Jeff Thompsonc69163b2013-10-12 13:49:50 -070040 */
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080041 inline virtual
42 ~Data();
Jeff Thompsonc69163b2013-10-12 13:49:50 -070043
44 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080045 * @brief Encode this Data for a wire format.
Jeff Thompsonb7aefa002013-09-16 18:22:00 -070046 * @return The encoded byte array.
47 */
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -080048 const Block&
49 wireEncode() const;
50
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080051 /**
52 * @brief Decode the input using a particular wire format and update this Data.
53 * @param input The input byte array to be decoded.
54 */
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -080055 void
56 wireDecode(const Block &wire);
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -080057
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080058 inline const Name&
59 getName() const;
Jeff Thompson5cae5e52013-07-10 19:41:20 -070060
61 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080062 * @brief Set name to a copy of the given Name.
63 *
Jeff Thompson0cd8c4a2013-09-13 17:46:40 -070064 * @param name The Name which is copied.
Jeff Thompson6d591972013-10-17 11:16:32 -070065 * @return This Data so that you can chain calls to update values.
Jeff Thompson0cd8c4a2013-09-13 17:46:40 -070066 */
Alexander Afanasyeva61757b2014-01-03 15:09:29 -080067 inline void
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080068 setName(const Name& name);
69
70 inline const MetaInfo&
71 getMetaInfo() const;
Jeff Thompson46bd45f2013-08-08 16:46:41 -070072
Jeff Thompson0cd8c4a2013-09-13 17:46:40 -070073 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080074 * @brief Set metaInfo to a copy of the given MetaInfo.
Jeff Thompson0cd8c4a2013-09-13 17:46:40 -070075 * @param metaInfo The MetaInfo which is copied.
Jeff Thompson6d591972013-10-17 11:16:32 -070076 * @return This Data so that you can chain calls to update values.
Jeff Thompson0cd8c4a2013-09-13 17:46:40 -070077 */
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080078 inline void
79 setMetaInfo(const MetaInfo& metaInfo);
Jeff Thompson46bd45f2013-08-08 16:46:41 -070080
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -080081 ///////////////////////////////////////////////////////////////
82 // MetaInfo proxy methods
83 inline uint32_t
84 getContentType() const;
85
86 inline void
87 setContentType(uint32_t type);
88
89 inline Milliseconds
90 getFreshnessPeriod() const;
91
92 inline void
93 setFreshnessPeriod(Milliseconds freshnessPeriod);
94
95 /**
96 * @brief Get content Block
97 *
98 * To access content value, one can use value()/value_size() or
99 * value_begin()/value_end() methods of the Block class
100 */
101 inline const Block&
102 getContent() const;
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800103
Jeff Thompson0899c0f2013-09-12 12:15:31 -0700104 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800105 * @brief Set the content to a copy of the data in the vector.
Jeff Thompson0899c0f2013-09-12 12:15:31 -0700106 * @param content A vector whose contents are copied.
Jeff Thompson6d591972013-10-17 11:16:32 -0700107 * @return This Data so that you can chain calls to update values.
Jeff Thompson0899c0f2013-09-12 12:15:31 -0700108 */
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800109 inline void
110 setContent(const uint8_t* content, size_t contentLength);
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800111
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800112 inline void
113 setContent(const Block& content);
114
115 inline void
116 setContent(const ConstBufferPtr &contentValue);
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800117
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800118 inline const Signature&
119 getSignature() const;
120
121 /**
122 * @brief Set the signature to a copy of the given signature.
123 * @param signature The signature object which is cloned.
124 * @return This Data so that you can chain calls to update values.
125 */
126 inline Data&
127 setSignature(const Signature& signature);
Jeff Thompsonc2b7b142013-09-12 15:29:04 -0700128
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700129private:
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700130 /**
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800131 * @brief Clear the wire encoding.
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700132 */
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800133 inline void
Jeff Thompson0050abe2013-09-17 12:50:25 -0700134 onChanged();
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800135
136private:
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700137 Name name_;
Jeff Thompsonfec716d2013-09-11 13:54:36 -0700138 MetaInfo metaInfo_;
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800139 mutable Block content_;
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800140 Signature signature_;
141
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800142 mutable Block wire_;
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700143};
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800144
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800145inline
146Data::Data()
147{
148}
149
150inline
151Data::Data(const Name& name)
152 : name_(name)
153{
154}
155
156inline
157Data::~Data()
158{
159}
160
161inline const Name&
162Data::getName() const
163{
164 return name_;
165}
166
167inline void
168Data::setName(const Name& name)
169{
170 onChanged();
171 name_ = name;
172}
173
174inline const MetaInfo&
175Data::getMetaInfo() const
176{
177 return metaInfo_;
178}
179
180inline void
181Data::setMetaInfo(const MetaInfo& metaInfo)
182{
183 onChanged();
184 metaInfo_ = metaInfo;
185}
186
187inline uint32_t
188Data::getContentType() const
189{
190 return metaInfo_.getType();
191}
192
193inline void
194Data::setContentType(uint32_t type)
195{
196 onChanged();
197 metaInfo_.setType(type);
198}
199
200inline Milliseconds
201Data::getFreshnessPeriod() const
202{
203 return metaInfo_.getFreshnessPeriod();
204}
205
206inline void
207Data::setFreshnessPeriod(Milliseconds freshnessPeriod)
208{
209 onChanged();
210 metaInfo_.setFreshnessPeriod(freshnessPeriod);
211}
212
213inline const Block&
214Data::getContent() const
215{
216 if (!content_.hasWire())
217 content_.encode();
218 return content_;
219}
220
221inline void
222Data::setContent(const uint8_t* content, size_t contentLength)
223{
224 onChanged();
225
226 OBufferStream os;
227 Tlv::writeVarNumber(os, Tlv::Content);
228 Tlv::writeVarNumber(os, contentLength);
229 os.write(reinterpret_cast<const char *>(content), contentLength);
230
231 content_ = Block(os.buf());
232}
233
234inline void
235Data::setContent(const ConstBufferPtr &contentValue)
236{
237 onChanged();
238
239 content_ = Block(Tlv::Content, contentValue); // not real a wire encoding yet
240}
241
242inline void
243Data::setContent(const Block& content)
244{
245 onChanged();
246
247 content_ = content;
248}
249
250inline const Signature&
251Data::getSignature() const
252{
253 return signature_;
254}
255
256inline Data&
257Data::setSignature(const Signature& signature)
258{
259 onChanged();
260 signature_ = signature;
261
262 return *this;
263}
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800264
265inline void
266Data::onChanged()
267{
Alexander Afanasyev2ba8f662014-01-05 22:53:18 -0800268 // The values have changed, so the wire format is invalidated
269
270 // !!!Note!!! Signature is not invalidated and it is responsibility of
271 // the application to do proper re-signing if necessary
272
273 wire_ = Block();
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700274}
275
Alexander Afanasyev4ff3c912014-01-03 15:25:02 -0800276std::ostream&
277operator << (std::ostream &os, const Data &data);
278
Alexander Afanasyevfadc97d2014-01-03 13:22:10 -0800279} // namespace ndn
280
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700281#endif