client.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <memory>
 
#include <ifw/fnd/defs/iCommAdapter.hpp>
 
namespace eso::uatools {

    class Client final : public ifw::fnd::defs::ICommAdapter {
    public:
        Client();
        ~Client() override;
 
        // Non-copyable, non-movable: a connection is a unique resource.
        Client(const Client&)            = delete;
        Client& operator=(const Client&) = delete;
        Client(Client&&)                 = delete;
        Client& operator=(Client&&)      = delete;
 
        // ----- ICommAdapter contract -----
 
        ifw::fnd::defs::Capabilities GetCapabilities() const override;
 
        // Lifecycle
        ifw::fnd::defs::Result
        Configure(const ifw::fnd::defs::ConnectionOptions& options) override;
        ifw::fnd::defs::Result Connect() override;
        ifw::fnd::defs::Result Disconnect() override;
        ifw::fnd::defs::ConnectionStatus GetConnectionStatus() const override;
        bool IsConnected() const override;
 
        ifw::fnd::defs::RegistrationToken
        SetConnectionStateHandler(
            ifw::fnd::defs::ConnectionStateHandler handler) override;
 
        // Synchronous data plane
        ifw::fnd::defs::DiscoverResult
        Discover(const ifw::fnd::defs::DiscoverRequest& request) override;
        ifw::fnd::defs::BrowseResult
        Browse(const ifw::fnd::defs::BrowseRequest& request) override;
        ifw::fnd::defs::ReadResult
        Read(const ifw::fnd::defs::ReadRequest& request) override;
        ifw::fnd::defs::WriteResult
        Write(const ifw::fnd::defs::WriteRequest& request) override;
        ifw::fnd::defs::CallResult
        Call(const ifw::fnd::defs::CallRequest& request) override;
 
        // Pub / Sub
        ifw::fnd::defs::SubscribeResult
        Subscribe(const std::vector<ifw::fnd::defs::Address>& nodes,
                  ifw::fnd::defs::SubscriptionHandler handler,
                  const ifw::fnd::defs::SubscribeOpts& opts = {}) override;
        ifw::fnd::defs::UnsubscribeResult
        Unsubscribe(const std::vector<ifw::fnd::defs::Address>& nodes) override;
        ifw::fnd::defs::Result UnsubscribeAll() override;
 
        // ----- ualib-specific convenience methods -----
        //
        // These are NOT part of ICommAdapter — they are OPC UA-flavoured
        // helpers exposed for callers that hold a concrete `Client&`.

        struct DataTypeInfo : ifw::fnd::defs::Result {
            std::string name;
        };

        DataTypeInfo ReadDataType(const ifw::fnd::defs::Address& node);
 
        // PIMPL: hides all open62541 types from the public header.
        // The struct itself is forward-declared here (definition lives
        // in ualib.cpp) so its members remain hidden — but the type
        // name needs to be reachable from file-scope helpers in the
        // implementation, hence `public` rather than `private`.
        struct Impl;
 
    private:
        std::unique_ptr<Impl> m_impl;
    };
 
}  // namespace eso::uatools