blob: 48bf041a788a73a556c3e623eb6cf53d892620f2 [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Alexander Afanasyeve289b532014-02-09 22:14:44 -08002/**
Alexander Afanasyevc169a812014-05-20 20:37:29 -04003 * Copyright (c) 2013-2014 Regents of the University of California.
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * 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.
Alexander Afanasyeve289b532014-02-09 22:14:44 -080020 */
21
Alexander Afanasyev26c24d22014-03-20 09:31:21 -070022#ifndef NDN_MANAGEMENT_NFD_CONTROLLER_HPP
23#define NDN_MANAGEMENT_NFD_CONTROLLER_HPP
Alexander Afanasyeve289b532014-02-09 22:14:44 -080024
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070025#include "nfd-control-command.hpp"
26#include "../face.hpp"
Junxiao Shi70911652014-08-12 10:14:24 -070027#include "../security/key-chain.hpp"
Junxiao Shi5de006b2014-10-26 20:20:52 -070028#include "nfd-command-options.hpp"
Alexander Afanasyeve289b532014-02-09 22:14:44 -080029
30namespace ndn {
Alexander Afanasyeve289b532014-02-09 22:14:44 -080031namespace nfd {
32
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040033/**
Alexander Afanasyev197e5652014-06-13 16:56:31 -070034 * \defgroup management Management
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040035 * \brief Classes and data structures to manage NDN forwarder
36 */
37/**
38 * \ingroup management
39 * \brief NFD Management protocol - ControlCommand client
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070040 */
Alexander Afanasyevee8bb1e2014-05-02 17:39:54 -070041class Controller : noncopyable
Alexander Afanasyeve289b532014-02-09 22:14:44 -080042{
43public:
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070044 /** \brief a callback on command success
Alexander Afanasyeve289b532014-02-09 22:14:44 -080045 */
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070046 typedef function<void(const ControlParameters&)> CommandSucceedCallback;
47
48 /** \brief a callback on command failure
49 */
50 typedef function<void(uint32_t/*code*/,const std::string&/*reason*/)> CommandFailCallback;
51
Junxiao Shi70911652014-08-12 10:14:24 -070052 /** \brief construct a Controller that uses face for transport,
53 * and uses the passed KeyChain to sign commands
54 */
55 Controller(Face& face, KeyChain& keyChain);
56
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070057 /** \brief start command execution
58 */
59 template<typename Command>
60 void
61 start(const ControlParameters& parameters,
Alexander Afanasyevd1b5c412014-03-27 15:03:51 -070062 const CommandSucceedCallback& onSuccess,
Junxiao Shi5c785d62014-04-20 18:10:20 -070063 const CommandFailCallback& onFailure,
Junxiao Shi5de006b2014-10-26 20:20:52 -070064 const CommandOptions& options = CommandOptions())
Yingdi Yue66bf2a2014-04-28 17:07:36 -070065 {
Junxiao Shi5de006b2014-10-26 20:20:52 -070066 shared_ptr<ControlCommand> command = make_shared<Command>();
67 this->startCommand(command, parameters, onSuccess, onFailure, options);
68 }
69
Alexander Afanasyeve289b532014-02-09 22:14:44 -080070private:
71 void
Junxiao Shi70911652014-08-12 10:14:24 -070072 startCommand(const shared_ptr<ControlCommand>& command,
73 const ControlParameters& parameters,
74 const CommandSucceedCallback& onSuccess,
75 const CommandFailCallback& onFailure,
Junxiao Shi5de006b2014-10-26 20:20:52 -070076 const CommandOptions& options);
77
Junxiao Shi70911652014-08-12 10:14:24 -070078 void
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070079 processCommandResponse(const Data& data,
80 const shared_ptr<ControlCommand>& command,
81 const CommandSucceedCallback& onSuccess,
82 const CommandFailCallback& onFailure);
hilata7d160f22014-03-13 19:51:42 -050083
Junxiao Shi5c785d62014-04-20 18:10:20 -070084public:
Junxiao Shi5de006b2014-10-26 20:20:52 -070085 /** \brief error code for timeout
86 * \note comes from http://msdn.microsoft.com/en-us/library/windows/desktop/ms740668.aspx
87 */
88 static const uint32_t ERROR_TIMEOUT;
89
90 /** \brief error code for server error
91 */
92 static const uint32_t ERROR_SERVER;
93
94 /** \brief inclusive lower bound of error codes
95 */
96 static const uint32_t ERROR_LBOUND;
97
hilataa99e37e2014-02-15 23:52:46 -060098protected:
Alexander Afanasyev0222fba2014-02-09 23:16:02 -080099 Face& m_face;
Junxiao Shi70911652014-08-12 10:14:24 -0700100 KeyChain& m_keyChain;
Alexander Afanasyeve289b532014-02-09 22:14:44 -0800101};
102
103} // namespace nfd
104} // namespace ndn
105
Alexander Afanasyev26c24d22014-03-20 09:31:21 -0700106#endif // NDN_MANAGEMENT_NFD_CONTROLLER_HPP