blob: af067a303f13bd3c9c0d275358acc9452f362b46 [file] [log] [blame]
Jeff Thompson47eecfc2013-07-07 22:56:46 -07001/**
Jeff Thompson7687dc02013-09-13 11:54:07 -07002 * Copyright (C) 2013 Regents of the University of California.
3 * @author: Jeff Thompson <jefft0@remap.ucla.edu>
Jeff Thompson47eecfc2013-07-07 22:56:46 -07004 * See COPYING for copyright and distribution information.
Jeff Thompsonb7f95562013-07-03 18:36:42 -07005 */
6
7#ifndef NDN_INTEREST_H
Jeff Thompson2d27e2f2013-08-09 12:55:00 -07008#define NDN_INTEREST_H
Jeff Thompsonb7f95562013-07-03 18:36:42 -07009
Jeff Thompson53412192013-08-06 13:35:50 -070010#include "name.h"
11#include "publisher-public-key-digest.h"
Jeff Thompsonb7f95562013-07-03 18:36:42 -070012
Jeff Thompson2d27e2f2013-08-09 12:55:00 -070013#ifdef __cplusplus
Jeff Thompsonb7f95562013-07-03 18:36:42 -070014extern "C" {
15#endif
16
Jeff Thompsonf084ec62013-07-09 12:32:52 -070017typedef enum {
18 ndn_Exclude_COMPONENT = 0,
19 ndn_Exclude_ANY = 1
20} ndn_ExcludeType;
21
22/**
23 * An ndn_ExcludeEntry holds an ndn_ExcludeType, and if it is a COMPONENT, it holds a pointer to the component value.
24 */
25struct ndn_ExcludeEntry {
26 ndn_ExcludeType type;
Jeff Thompson38d0e082013-08-12 18:07:44 -070027 struct ndn_NameComponent component;
Jeff Thompsonf084ec62013-07-09 12:32:52 -070028};
29
30/**
31 *
32 * @param self pointer to the ndn_NameComponent struct
33 * @param type one of the ndn_ExcludeType enum
34 * @param component the pre-allocated buffer for the component value, only used if type is ndn_Exclude_COMPONENT
35 * @param componentLength the number of bytes in value, only used if type is ndn_Exclude_COMPONENT
36 */
Jeff Thompson97223af2013-09-24 17:01:27 -070037static inline void ndn_ExcludeEntry_initialize(struct ndn_ExcludeEntry *self, ndn_ExcludeType type, uint8_t *component, size_t componentLength)
Jeff Thompsonf084ec62013-07-09 12:32:52 -070038{
39 self->type = type;
Jeff Thompsond1427fb2013-08-29 17:20:32 -070040 ndn_NameComponent_initialize(&self->component, component, componentLength);
Jeff Thompsonf084ec62013-07-09 12:32:52 -070041}
42
43/**
44 * An ndn_Exclude holds an array of ndn_ExcludeEntry.
45 */
46struct ndn_Exclude {
47 struct ndn_ExcludeEntry *entries; /**< pointer to the array of entries. */
Jeff Thompson97223af2013-09-24 17:01:27 -070048 size_t maxEntries; /**< the number of elements in the allocated entries array */
49 size_t nEntries; /**< the number of entries in the exclude, 0 for no exclude */
Jeff Thompsonf084ec62013-07-09 12:32:52 -070050};
51/**
52 * Initialize an ndn_Exclude struct with the entries array.
Jeff Thompson3548a962013-08-12 18:23:09 -070053 * @param self A pointer to the ndn_Exclude struct.
Jeff Thompsonf084ec62013-07-09 12:32:52 -070054 * @param entries the pre-allocated array of ndn_ExcludeEntry
55 * @param maxEntries the number of elements in the allocated entries array
56 */
Jeff Thompson97223af2013-09-24 17:01:27 -070057static inline void ndn_Exclude_initialize(struct ndn_Exclude *self, struct ndn_ExcludeEntry *entries, size_t maxEntries)
Jeff Thompsonf084ec62013-07-09 12:32:52 -070058{
59 self->entries = entries;
60 self->maxEntries = maxEntries;
61 self->nEntries = 0;
62}
63
Jeff Thompson2e0e0882013-08-12 17:55:13 -070064/**
65 * Compare the components using NDN component ordering.
66 * A component is less if it is shorter, otherwise if equal length do a byte comparison.
67 * @param component1 A pointer to the first name component.
68 * @param component2 A pointer to the second name component.
69 * @return -1 if component1 is less than component2, 1 if greater or 0 if equal.
70 */
71int ndn_Exclude_compareComponents(struct ndn_NameComponent *component1, struct ndn_NameComponent *component2);
72
Jeff Thompson3548a962013-08-12 18:23:09 -070073/**
74 * Check if the component matches any of the exclude criteria.
75 * @param self A pointer to the ndn_Exclude struct.
76 * @param component A pointer to the name component to check.
77 * @return 1 if the component matches any of the exclude criteria, otherwise 0.
78 */
79int ndn_Exclude_matches(struct ndn_Exclude *self, struct ndn_NameComponent *component);
80
Jeff Thompsonba70f8c2013-07-08 15:34:20 -070081enum {
82 ndn_Interest_CHILD_SELECTOR_LEFT = 0,
83 ndn_Interest_CHILD_SELECTOR_RIGHT = 1,
84 ndn_Interest_ANSWER_CONTENT_STORE = 1,
85 ndn_Interest_ANSWER_GENERATED = 2,
Jeff Thompson2d27e2f2013-08-09 12:55:00 -070086 ndn_Interest_ANSWER_STALE = 4, // Stale answer OK
87 ndn_Interest_MARK_STALE = 16, // Must have scope 0. Michael calls this a "hack"
Jeff Thompsonba70f8c2013-07-08 15:34:20 -070088
89 ndn_Interest_DEFAULT_ANSWER_ORIGIN_KIND = ndn_Interest_ANSWER_CONTENT_STORE | ndn_Interest_ANSWER_GENERATED
90};
91
Jeff Thompson8238d002013-07-10 11:56:49 -070092/**
93 * An ndn_Interest holds an ndn_Name and other fields for an interest.
94 */
Jeff Thompsonb7f95562013-07-03 18:36:42 -070095struct ndn_Interest {
96 struct ndn_Name name;
Jeff Thompson2d27e2f2013-08-09 12:55:00 -070097 int minSuffixComponents; /**< -1 for none */
98 int maxSuffixComponents; /**< -1 for none */
Jeff Thompson8238d002013-07-10 11:56:49 -070099 struct ndn_PublisherPublicKeyDigest publisherPublicKeyDigest;
Jeff Thompson2d27e2f2013-08-09 12:55:00 -0700100 struct ndn_Exclude exclude;
101 int childSelector; /**< -1 for none */
102 int answerOriginKind; /**< -1 for none */
103 int scope; /**< -1 for none */
104 double interestLifetimeMilliseconds; /**< milliseconds. -1.0 for none */
Jeff Thompson97223af2013-09-24 17:01:27 -0700105 uint8_t *nonce; /**< pointer to pre-allocated buffer. 0 for none */
106 size_t nonceLength; /**< length of nonce. 0 for none */
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700107};
108
Jeff Thompsonf084ec62013-07-09 12:32:52 -0700109/**
Jeff Thompsonb825c632013-07-10 17:59:29 -0700110 * Initialize an ndn_Interest struct with the pre-allocated nameComponents and excludeEntries,
Jeff Thompsonf084ec62013-07-09 12:32:52 -0700111 * and defaults for all the values.
112 * @param self pointer to the ndn_Interest struct
113 * @param nameComponents the pre-allocated array of ndn_NameComponent
114 * @param maxNameComponents the number of elements in the allocated nameComponents array
115 * @param excludeEntries the pre-allocated array of ndn_ExcludeEntry
116 * @param maxExcludeEntries the number of elements in the allocated excludeEntries array
117 */
Jeff Thompsond1427fb2013-08-29 17:20:32 -0700118static inline void ndn_Interest_initialize
Jeff Thompson97223af2013-09-24 17:01:27 -0700119 (struct ndn_Interest *self, struct ndn_NameComponent *nameComponents, size_t maxNameComponents,
120 struct ndn_ExcludeEntry *excludeEntries, size_t maxExcludeEntries)
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700121{
Jeff Thompsond1427fb2013-08-29 17:20:32 -0700122 ndn_Name_initialize(&self->name, nameComponents, maxNameComponents);
Jeff Thompson2d27e2f2013-08-09 12:55:00 -0700123 self->minSuffixComponents = -1;
Jeff Thompsonf2e5e282013-07-08 15:26:16 -0700124 self->maxSuffixComponents = -1;
Jeff Thompsond1427fb2013-08-29 17:20:32 -0700125 ndn_PublisherPublicKeyDigest_initialize(&self->publisherPublicKeyDigest);
126 ndn_Exclude_initialize(&self->exclude, excludeEntries, maxExcludeEntries);
Jeff Thompson2d27e2f2013-08-09 12:55:00 -0700127 self->childSelector = -1;
128 self->answerOriginKind = -1;
129 self->scope = -1;
130 self->interestLifetimeMilliseconds = -1.0;
131 self->nonce = 0;
132 self->nonceLength = 0;
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700133}
134
Jeff Thompsonac9b2c82013-08-13 10:51:59 -0700135/**
136 * Check if self's name matches the given name (using ndn_Name_match) and the given name also conforms to the
137 * interest selectors.
138 * @param self A pointer to the ndn_Interest struct.
139 * @param name A pointer to the name to check.
140 * @return 1 if the name and interest selectors match, 0 otherwise.
141 */
142int ndn_Interest_matchesName(struct ndn_Interest *self, struct ndn_Name *name);
143
Jeff Thompson2d27e2f2013-08-09 12:55:00 -0700144#ifdef __cplusplus
Jeff Thompsonb7f95562013-07-03 18:36:42 -0700145}
146#endif
147
148#endif
149