canonizer.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2020, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #ifndef NFD_TOOLS_NFDC_CANONIZER_HPP
27 #define NFD_TOOLS_NFDC_CANONIZER_HPP
28 
29 #include "core/common.hpp"
30 #include "execute-command.hpp"
31 #include "find-face.hpp"
32 
33 #include <ndn-cxx/net/face-uri.hpp>
34 
35 namespace nfd {
36 namespace tools {
37 namespace nfdc {
38 
42 std::pair<optional<FaceUri>, std::string>
43 canonize(ExecuteContext& ctx, const FaceUri& uri);
44 
51 std::pair<FindFace::Code, std::string>
52 canonizeErrorHelper(const FaceUri& uri,
53  const std::string& error,
54  const std::string& field = "");
55 
56 } // namespace nfdc
57 } // namespace tools
58 } // namespace nfd
59 
60 #endif // NFD_TOOLS_NFDC_CANONIZER_HPP
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
std::pair< FindFace::Code, std::string > canonizeErrorHelper(const FaceUri &uri, const std::string &error, const std::string &field)
helper to generate exit code and error message for face canonization failures
Definition: canonizer.cpp:47
std::pair< optional< FaceUri >, std::string > canonize(ExecuteContext &ctx, const FaceUri &uri)
canonize FaceUri
Definition: canonizer.cpp:33