Program Listing for File ClientApp.h

↰ Return to documentation for file (include/Karana/WebUI/ClientApp.h)

/*
 * Copyright (c) 2024-2026 Karana Dynamics Pty Ltd. All rights reserved.
 *
 * NOTICE TO USER:
 *
 * This source code and/or documentation (the "Licensed Materials") is
 * the confidential and proprietary information of Karana Dynamics Inc.
 * Use of these Licensed Materials is governed by the terms and conditions
 * of a separate software license agreement between Karana Dynamics and the
 * Licensee ("License Agreement"). Unless expressly permitted under that
 * agreement, any reproduction, modification, distribution, or disclosure
 * of the Licensed Materials, in whole or in part, to any third party
 * without the prior written consent of Karana Dynamics is strictly prohibited.
 *
 * THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 * KARANA DYNAMICS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * IN NO EVENT SHALL KARANA DYNAMICS BE LIABLE FOR ANY DAMAGES WHATSOEVER,
 * INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR USE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN CONTRACT, TORT,
 * OR OTHERWISE ARISING OUT OF OR IN CONNECTION WITH THE LICENSED MATERIALS.
 *
 * U.S. Government End Users: The Licensed Materials are a "commercial item"
 * as defined at 48 C.F.R. 2.101, and are provided to the U.S. Government
 * only as a commercial end item under the terms of this license.
 *
 * Any use of the Licensed Materials in individual or commercial software must
 * include, in the user documentation and internal source code comments,
 * this Notice, Disclaimer, and U.S. Government Use Provision.
 */

/**
 * @file
 * @brief Contains the declaration for the ClientApp class.
 */
#pragma once

#include <filesystem>
#include <memory>
#include <string>

namespace Karana::WebUI {

    /**
     * @class ClientApp
     * @brief Manages a karana-webui electron client instance
     */
    class ClientApp final {
      public:
        /**
         * @brief ClientApp constructor
         * @param url The server url to connect to
         */
        ClientApp(std::string_view url);

        /**
         * @brief ClientApp destructor
         */
        ~ClientApp();

        // Deleted copy operations to ensure single ownership of the process
        ClientApp(const ClientApp &) = delete;
        ClientApp &operator=(const ClientApp &) = delete;

        /**
         * @brief Find the full path of the karana-webui executable
         * @return The absolute path or empty if not found
         */
        static std::filesystem::path findExecutable();

        /**
         * @brief Idempotently close the app
         */
        void shutdown();

        /**
         * @brief Get a buffer containing the app's stdout
         * @return The stdout buffer
         */
        std::string getStdout() const;

        /**
         * @brief Get a buffer containing the app's stderr
         * @return The stderr buffer
         */
        std::string getStderr() const;

      private:
        std::unique_ptr<class ClientAppImpl> _impl;
    };

} // namespace Karana::WebUI