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_utils.hpp"
44 
45 #if OPENTHREAD_CONFIG_SRP_CLIENT_ENABLE
46 
47 namespace ot {
48 namespace Cli {
49 
50 /**
51  * Implements the SRP Client CLI interpreter.
52  *
53  */
54 class SrpClient : private Utils
55 {
56 public:
57     /**
58      * Constructor
59      *
60      * @param[in]  aInstance            The OpenThread Instance.
61      * @param[in]  aOutputImplementer   An `OutputImplementer`.
62      *
63      */
64     SrpClient(otInstance *aInstance, OutputImplementer &aOutputImplementer);
65 
66     /**
67      * Processes a CLI sub-command.
68      *
69      * @param[in]  aArgs     An array of command line arguments.
70      *
71      * @retval OT_ERROR_NONE              Successfully executed the CLI command.
72      * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
73      * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
74      * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
75      * @retval ...                        Error during execution of the CLI command.
76      *
77      */
78     otError Process(Arg aArgs[]);
79 
80 private:
81     static constexpr uint8_t kIndentSize       = 4;
82     static constexpr uint8_t kMaxHostAddresses = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_MAX_HOST_ADDRESSES;
83 
84     using Command = CommandEntry<SrpClient>;
85 
86     template <CommandId kCommandId> otError Process(Arg aArgs[]);
87 
88     otError ProcessServiceAdd(Arg aArgs[]);
89 
90     void OutputHostInfo(uint8_t aIndentSize, const otSrpClientHostInfo &aHostInfo);
91     void OutputServiceList(uint8_t aIndentSize, const otSrpClientService *aServices);
92     void OutputService(uint8_t aIndentSize, const otSrpClientService &aService);
93 
94     static void HandleCallback(otError                    aError,
95                                const otSrpClientHostInfo *aHostInfo,
96                                const otSrpClientService  *aServices,
97                                const otSrpClientService  *aRemovedServices,
98                                void                      *aContext);
99     void        HandleCallback(otError                    aError,
100                                const otSrpClientHostInfo *aHostInfo,
101                                const otSrpClientService  *aServices,
102                                const otSrpClientService  *aRemovedServices);
103 
104     bool mCallbackEnabled;
105 };
106 
107 } // namespace Cli
108 } // namespace ot
109 
110 #endif // OPENTHREAD_CONFIG_SRP_CLIENT_ENABLE
111 
112 #endif // CLI_SRP_CLIENT_HPP_
113