1 /*
2  *  Copyright (c) 2017, 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 CoAP server and client.
32  */
33 
34 #ifndef CLI_UDP_EXAMPLE_HPP_
35 #define CLI_UDP_EXAMPLE_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include <openthread/udp.h>
40 
41 #include "cli/cli_utils.hpp"
42 
43 namespace ot {
44 namespace Cli {
45 
46 /**
47  * Implements a CLI-based UDP example.
48  */
49 class UdpExample : private Utils
50 {
51 public:
52     /**
53      * Constructor
54      *
55      * @param[in]  aInstance            The OpenThread Instance.
56      * @param[in]  aOutputImplementer   An `OutputImplementer`.
57      */
58     UdpExample(otInstance *aInstance, OutputImplementer &aOutputImplementer);
59 
60     /**
61      * Processes a CLI sub-command.
62      *
63      * @param[in]  aArgs     An array of command line arguments.
64      *
65      * @retval OT_ERROR_NONE              Successfully executed the CLI command.
66      * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
67      * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
68      * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
69      * @retval ...                        Error during execution of the CLI command.
70      */
71     otError Process(Arg aArgs[]);
72 
73 private:
74     using Command = CommandEntry<UdpExample>;
75 
76     template <CommandId kCommandId> otError Process(Arg aArgs[]);
77 
78     static otError PrepareAutoGeneratedPayload(otMessage &aMessage, uint16_t aPayloadLength);
79     static otError PrepareHexStringPayload(otMessage &aMessage, const char *aHexString);
80 
81     static void HandleUdpReceive(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo);
82     void        HandleUdpReceive(otMessage *aMessage, const otMessageInfo *aMessageInfo);
83 
84     bool        mLinkSecurityEnabled;
85     otUdpSocket mSocket;
86 };
87 
88 } // namespace Cli
89 } // namespace ot
90 
91 #endif // CLI_UDP_EXAMPLE_HPP_
92