• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2016, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file contains definitions for the CLI interpreter.
32  */
33 
34 #ifndef CLI_DATASET_HPP_
35 #define CLI_DATASET_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include <stdarg.h>
40 
41 #include <openthread/dataset.h>
42 
43 #include "cli/cli_output.hpp"
44 
45 namespace ot {
46 namespace Cli {
47 
48 /**
49  * This class implements the Dataset CLI interpreter.
50  *
51  */
52 class Dataset : private OutputWrapper
53 {
54 public:
55     typedef Utils::CmdLineParser::Arg Arg;
56 
Dataset(Output & aOutput)57     explicit Dataset(Output &aOutput)
58         : OutputWrapper(aOutput)
59     {
60     }
61 
62     /**
63      * This method interprets a list of CLI arguments.
64      *
65      * @param[in]  aArgs        An array of command line arguments.
66      *
67      */
68     otError Process(Arg aArgs[]);
69 
70 private:
71     using Command = CommandEntry<Dataset>;
72 
73     template <CommandId kCommandId> otError Process(Arg aArgs[]);
74 
75     otError Print(otOperationalDataset &aDataset);
76 
77 #if OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE && OPENTHREAD_FTD
78     otError     ProcessUpdater(Arg aArgs[]);
79     static void HandleDatasetUpdater(otError aError, void *aContext);
80     void        HandleDatasetUpdater(otError aError);
81 #endif
82 
83     void    OutputSecurityPolicy(const otSecurityPolicy &aSecurityPolicy);
84     otError ParseSecurityPolicy(otSecurityPolicy &aSecurityPolicy, Arg *&aArgs);
85 
86     static otOperationalDataset sDataset;
87 };
88 
89 } // namespace Cli
90 } // namespace ot
91 
92 #endif // CLI_DATASET_HPP_
93