src/cli/cli_plat_tcp.hpp

/*
 *  Copyright (c) 2026, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file
 *   This file contains definitions for a plat-TCP CLI tool.
 */

#ifndef OT_CLI_CLI_PLAT_TCP_HPP_
#define OT_CLI_CLI_PLAT_TCP_HPP_

#include "openthread-core-config.h"

#if OPENTHREAD_CONFIG_PLATFORM_TCP_ENABLE && OPENTHREAD_CONFIG_CLI_PLAT_TCP_ENABLE

#include "cli/cli_config.h"
#include "cli/cli_utils.hpp"

#include "net/plat_tcp.hpp"

namespace ot {
namespace Cli {

/**
 * Implements a CLI-based plat-TCP example.
 *
 * These CLI commands are intended primarily for testing and evaluation of the `otPlatTcp` API implementations.
 */
class PlatTcp : private Utils
{
public:
    /**
     * Constructor
     *
     * @param[in]  aInstance            The OpenThread Instance.
     * @param[in]  aOutputImplementer   An `OutputImplementer`.
     */
    PlatTcp(otInstance *aInstance, OutputImplementer &aOutputImplementer);

    /**
     * Processes a CLI sub-command.
     *
     * @param[in]  aArgs     An array of command line arguments.
     *
     * @retval OT_ERROR_NONE              Successfully executed the CLI command.
     * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
     * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
     * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
     * @retval ...                        Error during execution of the CLI command.
     */
    otError Process(Arg aArgs[]);

private:
    using Command = CommandEntry<PlatTcp>;

    using SockAddr = Ip6::PlatTcp::SockAddr;

    class Listener : public Ip6::PlatTcp::Listener
    {
    public:
        Listener(Instance &aInstance, PlatTcp &aOwner);

    private:
        static Ip6::PlatTcp::Connection *Accept(Ip6::PlatTcp::Listener &aListener, const SockAddr &aPeerSockAddr);

        PlatTcp &mOwner;
    };

    class Connection : public Ip6::PlatTcp::Connection
    {
    public:
        Connection(Instance &aInstance, PlatTcp &aOwner);

    private:
        static void HandleEvent(Ip6::PlatTcp::Connection &aConnection, Event aEvent);

        PlatTcp &mOwner;
    };

    template <CommandId kCommandId> otError Process(Arg aArgs[]);

    otError     GetSockAddr(Arg aArgs[], SockAddr &aSockAddr);
    Connection *Accept(const SockAddr &aPeerSockAddr);
    void        HandleEvent(Connection::Event aEvent);

    Listener   mListener;
    Connection mConnection;
    SockAddr   mLocalSockAddr;
    bool       mIsBound;
};

} // namespace Cli
} // namespace ot

#endif // OPENTHREAD_CONFIG_PLATFORM_TCP_ENABLE && OPENTHREAD_CONFIG_CLI_PLAT_TCP_ENABLE

#endif // OT_CLI_CLI_PLAT_TCP_HPP_