NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
interest-filter.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
24 
25 namespace ndn {
26 
28  : m_prefix(prefix)
29 {
30 }
31 
32 InterestFilter::InterestFilter(const char* prefixUri)
33  : m_prefix(prefixUri)
34 {
35 }
36 
37 InterestFilter::InterestFilter(const std::string& prefixUri)
38  : m_prefix(prefixUri)
39 {
40 }
41 
42 InterestFilter::InterestFilter(const Name& prefix, const std::string& regexFilter)
43  : m_prefix(prefix)
44  , m_regexFilter(make_shared<RegexPatternListMatcher>(regexFilter, nullptr))
45 {
46 }
47 
48 InterestFilter::operator const Name&() const
49 {
50  if (hasRegexFilter()) {
51  BOOST_THROW_EXCEPTION(Error("Please update InterestCallback to accept const InterestFilter&"
52  " (non-trivial InterestFilter is being used)"));
53  }
54  return m_prefix;
55 }
56 
57 bool
59 {
60  return m_prefix.isPrefixOf(name) &&
61  (!hasRegexFilter() ||
62  m_regexFilter->match(name, m_prefix.size(), name.size() - m_prefix.size()));
63 }
64 
65 std::ostream&
66 operator<<(std::ostream& os, const InterestFilter& filter)
67 {
68  os << filter.getPrefix();
69  if (filter.hasRegexFilter()) {
70  os << "?regex=" << filter.getRegexFilter();
71  }
72  return os;
73 }
74 
75 } // namespace ndn
Copyright (c) 2011-2015 Regents of the University of California.
const Name & getPrefix() const
std::ostream & operator<<(std::ostream &os, const Data &data)
Definition: data.cpp:322
bool isPrefixOf(const Name &other) const
Check if this name is a prefix of another name.
Definition: name.cpp:251
declares the set of Interests a producer can serve, which starts with a name prefix,...
bool doesMatch(const Name &name) const
Check if specified Interest name matches the filter.
const RegexPatternListMatcher & getRegexFilter() const
Represents an absolute name.
Definition: name.hpp:43
bool hasRegexFilter() const
size_t size() const
Get number of components.
Definition: name.hpp:147
InterestFilter(const Name &prefix)
Construct an InterestFilter to match Interests by prefix.