1 /* 2 * Copyright (c) 2024, 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 for Ping Sneder function. 32 */ 33 34 #ifndef CLI_PING_SENDER_HPP_ 35 #define CLI_PING_SENDER_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include <openthread/ping_sender.h> 40 41 #include "cli/cli_utils.hpp" 42 43 #if OPENTHREAD_CONFIG_PING_SENDER_ENABLE 44 45 namespace ot { 46 namespace Cli { 47 48 /** 49 * Implements the Ping Sender CLI interpreter. 50 */ 51 52 class PingSender : private Utils 53 { 54 public: 55 /** 56 * Constructor 57 * 58 * @param[in] aInstance The OpenThread Instance. 59 * @param[in] aOutputImplementer An `OutputImplementer`. 60 */ 61 PingSender(otInstance *aInstance, OutputImplementer &aOutputImplementer); 62 63 /** 64 * Processes a CLI sub-command. 65 * 66 * @param[in] aArgs An array of command line arguments. 67 * 68 * @retval OT_ERROR_NONE Successfully executed the CLI command. 69 * @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending. 70 * @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command. 71 * @retval OT_ERROR_INVALID_ARGS Invalid arguments. 72 * @retval ... Error during execution of the CLI command. 73 */ 74 otError Process(Arg aArgs[]); 75 76 private: 77 otError ParsePingInterval(const Arg &aArg, uint32_t &aInterval); 78 79 static void HandlePingReply(const otPingSenderReply *aReply, void *aContext); 80 void HandlePingReply(const otPingSenderReply *aReply); 81 static void HandlePingStatistics(const otPingSenderStatistics *aStatistics, void *aContext); 82 void HandlePingStatistics(const otPingSenderStatistics *aStatistics); 83 84 void OutputResult(otError aError); 85 86 bool mPingIsAsync : 1; 87 }; 88 89 } // namespace Cli 90 } // namespace ot 91 92 #endif // OPENTHREAD_CONFIG_PING_SENDER_ENABLE 93 94 #endif // CLI_PING_SENDER_HPP_ 95