1 /* 2 * Copyright (c) 2019, 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 a simple CLI to control the Joiner role. 32 */ 33 34 #ifndef CLI_JOINER_HPP_ 35 #define CLI_JOINER_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include <openthread/joiner.h> 40 41 #include "cli/cli_output.hpp" 42 43 #if OPENTHREAD_CONFIG_JOINER_ENABLE 44 45 namespace ot { 46 namespace Cli { 47 48 /** 49 * This class implements the Joiner CLI interpreter. 50 * 51 */ 52 class Joiner : private OutputWrapper 53 { 54 public: 55 typedef Utils::CmdLineParser::Arg Arg; 56 57 /** 58 * Constructor 59 * 60 * @param[in] aOutput The CLI console output context 61 * 62 */ Joiner(Output & aOutput)63 explicit Joiner(Output &aOutput) 64 : OutputWrapper(aOutput) 65 { 66 } 67 68 /** 69 * This method interprets a list of CLI arguments. 70 * 71 * @param[in] aArgs A pointer to an array of command line arguments. 72 * 73 */ 74 otError Process(Arg aArgs[]); 75 76 private: 77 using Command = CommandEntry<Joiner>; 78 79 template <CommandId kCommandId> otError Process(Arg aArgs[]); 80 81 static void HandleCallback(otError aError, void *aContext); 82 void HandleCallback(otError aError); 83 }; 84 85 } // namespace Cli 86 } // namespace ot 87 88 #endif // OPENTHREAD_CONFIG_JOINER_ENABLE 89 90 #endif // CLI_JOINER_HPP_ 91