// ===----------------------------------------------------------------------===
//
// This source file is part of the Hummingbird DocC Middleware open source project
//
// Copyright (c) 2025 Röck+Cöde VoF. and the Hummingbird DocC Middleware project authors
// Licensed under the EUPL 1.2 or later.
//
// See LICENSE for license information
// See CONTRIBUTORS for the list of Hummingbird DocC Middleware project authors
//
// ===----------------------------------------------------------------------===

import protocol ArgumentParser.ParsableArguments

import struct ArgumentParser.Option

extension SampleApp {
    /// A type that conforms to the `ParsableArguments` protocol, which contains the input parameters required for the execution of the sample executable.
    struct Parameters: ParsableArguments {
        
        // MARK: Properties

        /// A label given to the sample app to identify it within a communications channel.
        @Option(
            name: .shortAndLong,
            help: "A label given to the sample app for the sole purpose of identification within a communications channel."
        )
        var hostname: String = "127.0.0.1"
    
        /// A port number assigned to the sample app from where the app either sends or receives data.
        @Option(
            name: .shortAndLong,
            help: "A port number assigned to the sample app from where the app either sends or receives data."
        )
        var port: Int = 8080
    }
}