InstrumentProfileConnection.hpp

// Copyright (c) 2025 Devexperts LLC.
// SPDX-License-Identifier: MPL-2.0
 
#pragma once
 
#include "../../internal/Conf.hpp"
 
DXFCXX_DISABLE_MSC_WARNINGS_PUSH(4251)
 
#include "../../entity/SharedEntity.hpp"
#include "../../internal/Common.hpp"
#include "../../internal/Id.hpp"
#include "../../internal/JavaObjectHandle.hpp"
#include "./InstrumentProfileCollector.hpp"
 
/**
 * \addtogroup dxfcpp_ipf
 * @{
 */
 
DXFCPP_BEGIN_NAMESPACE
 
/**
 * Connects to an instrument profile URL and reads instrument profiles with support of
 * streaming live updates.
 * Please see <b>Instrument Profile Format</b> documentation for complete description.
 */
class DXFCPP_EXPORT InstrumentProfileConnection final : public SharedEntity {
    public:
    /// The alias to a type of shared pointer to the InstrumentProfileConnection object
    using Ptr = std::shared_ptr<InstrumentProfileConnection>;
 
    /// The alias to a type of unique pointer to the InstrumentProfileConnection object
    using Unique = std::unique_ptr<InstrumentProfileConnection>;
 
    /**
     * Instrument profile connection state.
     */
    enum class State : std::int32_t {
        /**
         * Instrument profile connection is not started yet.
         * @ref InstrumentProfileConnection::start() "start" was not invoked yet.
         */
        NOT_CONNECTED,
 
        /**
         * Connection is being established.
         */
        CONNECTING,
 
        /**
         * Connection was established.
         */
        CONNECTED,
 
        /**
         * Initial instrument profiles snapshot was fully read (this state is set only once).
         */
        COMPLETED,
 
        /**
         * Instrument profile connection was @ref InstrumentProfileConnection::close() "closed".
         */
        CLOSED
    };
 
    private:
    Id<InstrumentProfileConnection> id_;
    JavaObjectHandle<InstrumentProfileConnection> handle_{};
    JavaObjectHandle<IpfPropertyChangeListener> stateChangeListenerHandle_{};
    SimpleHandler<void(State, State)> onStateChange_{};
 
    InstrumentProfileConnection() noexcept;
 
    struct Impl;
 
    public:
    static std::string stateToString(State state) noexcept;
 
    /**
     * Creates instrument profile connection with a specified address and collector.
     * Address may be just "<host>:<port>" of server, URL, or a file path.
     * The "[update=<period>]" clause can be optionally added at the end of the address to
     * specify an @ref InstrumentProfileConnection::getUpdatePeriod() "update period" via an address string.
     * Default update period is 1 minute.
     *
     * <p>Connection needs to be @ref InstrumentProfileConnection::start() "started" to begin an actual operation.
     *
     * @param address The address.
     * @param collector The instrument profile collector to push updates into.
     *
     * @return new instrument profile connection.
     */
    static Ptr createConnection(const StringLike &address, InstrumentProfileCollector::Ptr collector);
 
    /**
     * Returns the address of this instrument profile connection.
     * It does not include additional options specified as part of the address.
     *
     * @return The address of this instrument profile connection.
     */
    std::string getAddress() const;
 
    /**
     * Returns update period in milliseconds.
     * It is period of an update check when the instrument profiles source does not support live updates
     * and/or when connection is dropped.
     * Default update period is 1 minute, unless overridden in an
     * @ref InstrumentProfileConnection::createConnection() "address string".
     *
     * @return The update period in milliseconds.
     */
    std::int64_t getUpdatePeriod() const;
 
    /**
     * Returns update period in milliseconds as chrono::duration
     * It is period of an update check when the instrument profiles source does not support live updates
     * and/or when connection is dropped.
     * Default update period is 1 minute, unless overridden in an
     * @ref InstrumentProfileConnection::createConnection() "address string".
     *
     * @return The update period in milliseconds as chrono::duration.
     */
    std::chrono::milliseconds getUpdatePeriodAsDuration() const;
 
    /**
     * Changes the update period in milliseconds.
     *
     * @param updatePeriod The update period in milliseconds.
     * @see InstrumentProfileConnection::getUpdatePeriod()
     */
    void setUpdatePeriod(std::int64_t updatePeriod) const;
 
    /**
     * Changes the update period in milliseconds as chrono::duration.
     *
     * @param updatePeriod The update period in milliseconds as chrono::duration.
     * @see InstrumentProfileConnection::getUpdatePeriod()
     */
    void setUpdatePeriod(std::chrono::milliseconds updatePeriod) const;
 
    /**
     * Returns state of this instrument profile connections.
     *
     * @return The state of this instrument profile connections.
     */
    State getState() const;
 
    /**
     * Returns last modification time (in milliseconds) of instrument profiles or zero if it is unknown.
     * Note, that while the time is represented in milliseconds, the actual granularity of time here is a second.
     *
     * @return The last modification time (in milliseconds) of instrument profiles or zero if it is unknown.
     */
    std::int64_t getLastModified() const;
 
    /**
     * Starts this instrument profile connection. This connection's state immediately changes to
     * @ref InstrumentProfileConnection::State::CONNECTING "CONNECTING" and the actual connection establishment proceeds
     * in the background.
     */
    void start() const;
 
    /**
     * Closes this instrument profile connection. This connection's state immediately changes to
     * @ref InstrumentProfileConnection::State::CLOSED "CLOSED" and the background update procedures are terminated.
     */
    void close() const;
 
    /**
     * Adds listener that is notified about changes in @ref InstrumentProfileConnection::getState() "state" property.
     *
     * <p>Installed listener can be removed by `id` with InstrumentProfileConnection::removeStateChangeListener method
     * or by call `InstrumentProfileConnection::onStateChange() -= id`;
     *
     * @tparam StateChangeListener The listener type. It can be any callable with signature: `void(State, State)`
     * @param listener The listener to add
     * @return the listener id
     */
    template <typename StateChangeListener>
    std::size_t addStateChangeListener(StateChangeListener &&listener)
#if __cpp_concepts
        requires requires {
            { listener(State{}, State{}) } -> std::same_as<void>;
        }
#endif
    {
        return onStateChange_ += listener;
    }
 
    /**
     * Removes listener that is notified about changes in @ref InstrumentProfileConnection::getState() "state" property.
     * It removes the listener that was previously installed with InstrumentProfileConnection::addStateChangeListener
     * method.
     *
     * @param listenerId The listener id to remove
     */
    void removeStateChangeListener(std::size_t listenerId);
 
    /**
     * Returns the onStateChange @ref SimpleHandler<void(ArgTypes...)> "handler" that can be used to add or remove
     * listeners.
     *
     * @return onStateChange handler with `void(State, State)` signature
     */
    SimpleHandler<void(State, State)> &onStateChange();
 
    /**
     * Synchronously waits for full first snapshot read with the specified timeout.
     *
     * @param timeout The maximum time (in millis) to wait
     * @return `true` if @ref InstrumentProfileConnection::State::COMPLETED "COMPLETED" state was reached and `false`
     *         if the waiting time elapsed before snapshot was fully read.
     */
    bool waitUntilCompleted(std::int64_t timeout) const;
 
    /**
     * Synchronously waits for full first snapshot read with the specified timeout.
     *
     * @param timeout The maximum time to wait
     * @return `true` if @ref InstrumentProfileConnection::State::COMPLETED "COMPLETED" state was reached and `false`
     *         if the waiting time elapsed before snapshot was fully read.
     */
    bool waitUntilCompleted(std::chrono::milliseconds timeout) const;
};
 
DXFCPP_END_NAMESPACE
 
/// @}
 
DXFCXX_DISABLE_MSC_WARNINGS_POP()