1 /* 2 * Copyright (c) 2020, 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 SRP Client. 32 */ 33 34 #ifndef CLI_SRP_CLIENT_HPP_ 35 #define CLI_SRP_CLIENT_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include <openthread/srp_client.h> 40 #include <openthread/srp_client_buffers.h> 41 42 #include "cli/cli_config.h" 43 #include "cli/cli_output.hpp" 44 45 #if OPENTHREAD_CONFIG_SRP_CLIENT_ENABLE 46 47 namespace ot { 48 namespace Cli { 49 50 /** 51 * This class implements the SRP Client CLI interpreter. 52 * 53 */ 54 class SrpClient : private OutputWrapper 55 { 56 public: 57 typedef Utils::CmdLineParser::Arg Arg; 58 59 /** 60 * Constructor 61 * 62 * @param[in] aOutput The CLI console output context. 63 * 64 */ 65 explicit SrpClient(Output &aOutput); 66 67 /** 68 * This method interprets a list of CLI arguments. 69 * 70 * @param[in] aArgs A pointer an array of command line arguments. 71 * 72 */ 73 otError Process(Arg aArgs[]); 74 75 private: 76 enum : uint8_t 77 { 78 kMaxHostAddresses = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_MAX_HOST_ADDRESSES, 79 kIndentSize = 4, 80 }; 81 82 using Command = CommandEntry<SrpClient>; 83 84 template <CommandId kCommandId> otError Process(Arg aArgs[]); 85 86 otError ProcessServiceAdd(Arg aArgs[]); 87 88 void OutputHostInfo(uint8_t aIndentSize, const otSrpClientHostInfo &aHostInfo); 89 void OutputServiceList(uint8_t aIndentSize, const otSrpClientService *aServices); 90 void OutputService(uint8_t aIndentSize, const otSrpClientService &aService); 91 92 static void HandleCallback(otError aError, 93 const otSrpClientHostInfo *aHostInfo, 94 const otSrpClientService * aServices, 95 const otSrpClientService * aRemovedServices, 96 void * aContext); 97 void HandleCallback(otError aError, 98 const otSrpClientHostInfo *aHostInfo, 99 const otSrpClientService * aServices, 100 const otSrpClientService * aRemovedServices); 101 102 bool mCallbackEnabled; 103 }; 104 105 } // namespace Cli 106 } // namespace ot 107 108 #endif // OPENTHREAD_CONFIG_SRP_CLIENT_ENABLE 109 110 #endif // CLI_SRP_CLIENT_HPP_ 111