api_docs_2023-6/SubscriptionServiceProxy_8hpp_source.html

//

//  Copyright PHOENIX CONTACT Electronics GmbH

//

#pragma once

#include "Arp/System/Core/Arp.h"

#include "Arp/System/Rsc/Services/RscServiceProxyBase.hxx"

#include "Arp/Plc/Gds/Services/ISubscriptionService.hpp"


// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ISubscriptionService.cs


namespace Arp { namespace Plc { namespace Gds { namespace Services

{


using namespace Arp;


class SubscriptionServiceProxy : public RscServiceProxyBase<ISubscriptionService>

{

public: // construction/destruction

    SubscriptionServiceProxy(RscHandle providerHandle, RscHandle serviceHandle, RscClient& rscClient);


public: // ISubscriptionService operations

    uint32          CreateSubscription(SubscriptionKind kind)override;

    uint32          CreateRecordingSubscription(uint16 recordCount)override;

    DataAccessError AddVariable(uint32 subscriptionId, const RscString<512>& variableName)override;

    void            AddVariables(uint32 subscriptionId, AddVariablesVariableNamesDelegate variableNamesDelegate, AddVariablesResultDelegate resultDelegate)override;

    DataAccessError RemoveVariable(uint32 subscriptionId, const RscString<512>& variableName)override;

    DataAccessError Subscribe(uint32 subscriptionId, uint64 sampleRate)override;

    DataAccessError Resubscribe(uint32 subscriptionId, uint64 sampleRate)override;

    DataAccessError Unsubscribe(uint32 subscriptionId)override;

    DataAccessError DeleteSubscription(uint32 subscriptionId)override;

    DataAccessError GetVariableInfos(uint32 subscriptionId, GetVariableInfosVariableInfoDelegate variableInfoDelegate)override;

    DataAccessError GetTimeStampedVariableInfos(uint32 subscriptionId, GetTimeStampedVariableInfosVariableInfoDelegate variableInfoDelegate)override;

    DataAccessError GetRecordInfos(uint32 subscriptionId, GetRecordInfosRecordInfosDelegate recordInfosDelegate)override;

    DataAccessError ReadValues(uint32 subscriptionId, ReadValuesValuesDelegate valuesDelegate)override;

    DataAccessError ReadTimeStampedValues(uint32 subscriptionId, ReadTimeStampedValuesValuesDelegate valuesDelegate)override;

    DataAccessError ReadRecords(uint32 subscriptionId, uint16 count, ReadRecordsRecordsDelegate recordsDelegate)override;

};


}}}} // end of namespace Arp::Plc::Gds::Services

Arp.h

Arp::Plc::Gds::Services::SubscriptionServiceProxy
Proxy class of service ISubscriptionService
Definition: SubscriptionServiceProxy.hpp:20

Arp::Plc::Gds::Services::SubscriptionServiceProxy::SubscriptionServiceProxy
SubscriptionServiceProxy(RscHandle providerHandle, RscHandle serviceHandle, RscClient &rscClient)
Constructs an instance of type SubscriptionServiceProxy

Arp::System::Rsc::Services::RscString< 512 >

Arp::uint64
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:40

Arp::uint32
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:36

Arp::uint16
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:32

Arp::Plc::Gds::Services::DataAccessError
DataAccessError
This enumeration contains the possible data access errors.
Definition: DataAccessError.hpp:19

Arp::Plc::Gds::Services::SubscriptionKind
SubscriptionKind
This enumeration contains the possible kinds of subscriptions.
Definition: SubscriptionKind.hpp:28

Arp
Root namespace for the PLCnext API