RscClient.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Commons/Net/Url.hpp"
#include "Arp/Base/Commons/Security/SecurityToken.hpp"
#include "Arp/Base/Rsc/Commons/Rsc.hpp"
#include "Arp/Base/Rsc/Commons/Services/RscReader.hpp"
#include "Arp/Base/Rsc/Commons/Services/RscWriter.hpp"
#include "Arp/Base/Rsc/Commons/Services/RscServiceHandle.hpp"
 
namespace Arp::Base::Rsc::Commons::Services
{
 
// type imports
using Arp::Base::Commons::Net::Url;
 
class ARP_EXPORT RscClient
{
public: // nested types forward declaration
    class Impl;
    class TransactionGuard;
 
public: // construction
    RscClient(const String& ipcAppName);
    RscClient(const Url& url = Url::GetEmpty());
 
    // canonical construction/destruction/assignment
    RscClient(const RscClient& arg) = delete;
    RscClient(RscClient&& arg)noexcept;
    RscClient& operator=(const RscClient& arg) = delete;
    RscClient& operator=(RscClient&& arg)noexcept;
    ~RscClient(void);
 
public: // setter/getter operations
    bool        IsIpc(void)const;
    bool        IsConnected(void)const;
    RscReader&  GetReader(void);
    RscWriter&  GetWriter(void);
 
public: // operations
    void        Connect(const Url& url = Url::GetEmpty());
    bool        TryConnect(const Url& url = Url::GetEmpty());
    void        Reconnect(const Url& url = Url::GetEmpty());
    bool        TryReconnect(const Url& url = Url::GetEmpty());
    void        Disconnect(void);
    void        Close(bool disconnectRemoting = true);
    void        Authenticate(SecurityToken authenticationToken);
    RscHandle   GetServiceHandle(RscHandle serviceProviderHandle, const char* serviceName);
    RscHandle   GetServiceHandle(const char* serviceProviderName, const char* serviceName);
    RscHandle   GetServiceProviderHandle(const char* serviceProviderName);
    void        GetServiceHandles(const char* serviceProviderName, const char* serviceName, RscHandle& serviceProviderHandle, RscHandle& serviceHandle);
    void        GetRscServiceHandle(const char* serviceProviderName, const char* serviceName, RscServiceHandle& rscServiceHandle);
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Base::Rsc::Commons::Services