IRPCCon.h

Go to the documentation of this file.

 
 
#pragma once
 
#include <asio/io_context.hpp>
#include <cstdint>
#include <map>
#include <optional>
#include <string>
#include <vector>
 
#include "profinet/blocks.h"
#include "profinet/cyclic.h"
#include "profinet/dcp.h"
#include "profinet/diagnosis.h"
#include "profinet/protocol.h"
#include "profinet/rpcTypes.h"
#include "profinet/util.h"
 
namespace profinet::rpc
{
struct EPMEndpoint
{
  std::string interfaceUuid;
 
  std::uint16_t interfaceVersionMajor = 0;
 
  std::uint16_t interfaceVersionMinor = 0;
 
  std::string objectUuid;
 
  std::string protocol;
 
  std::uint16_t port = 0;
 
  std::string ipAddress;
 
  std::string annotation;
 
  [[nodiscard]] std::string InterfaceName() const;
};
 
class IRPCCon
{
 public:
  virtual ~IRPCCon() = default;
 
  virtual std::optional<ConnectResult> Connect(std::optional<MacAddress> srcMac = std::nullopt, bool withAlarmCr = false, std::optional<IOCRSetup> iocrSetup = std::nullopt) = 0;
 
  virtual void Disconnect() = 0;
 
  virtual void Close() noexcept = 0;
 
  [[nodiscard]] virtual bool IsConnected() const = 0;
 
  virtual PNIODHeader Read(std::uint32_t api, std::uint16_t slot, std::uint16_t subslot, std::uint16_t idx) = 0;
 
  virtual PNIODHeader ReadImplicit(std::uint32_t api, std::uint16_t slot, std::uint16_t subslot, std::uint16_t idx) = 0;
 
  virtual void Write(std::uint32_t api, std::uint16_t slot, std::uint16_t subslot, std::uint16_t idx, const Bytes& data) = 0;
 
  virtual std::vector<blocks::WriteMultipleResult> WriteMultiple(const std::vector<WriteItem>& writes) = 0;
 
  virtual PNInM0 ReadIm0(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM1 ReadIm1(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM2 ReadIm2(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM3 ReadIm3(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM4 ReadIm4(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM5 ReadIm5(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM6 ReadIm6(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM7 ReadIm7(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM8 ReadIm8(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM9 ReadIm9(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM10 ReadIm10(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM11 ReadIm11(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM12 ReadIm12(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM13 ReadIm13(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM14 ReadIm14(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual PNInM15 ReadIm15(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual AllIM ReadAllIm(std::uint16_t slot = 0, std::uint16_t subslot = 1) = 0;
 
  virtual blocks::ModuleDiffBlock ReadModuleDiff() = 0;
 
  virtual diagnosis::DiagnosisData ReadDiagnosis(std::uint16_t slot = 0, std::uint16_t subslot = 0, std::uint16_t index = 0xF000) = 0;
 
  virtual std::map<std::uint16_t, diagnosis::DiagnosisData> ReadAllDiagnosis() = 0;
 
  virtual blocks::PDRealData ReadPdRealData() = 0;
 
  virtual blocks::RealIdentificationData ReadRealIdentificationData() = 0;
 
  virtual std::vector<blocks::SlotInfo> DiscoverSlots() = 0;
 
  virtual std::pair<blocks::PDRealData, blocks::RealIdentificationData> DiscoverTopology() = 0;
 
  virtual std::map<std::uint16_t, IndexProbeResult> EnumerateIndices(std::uint16_t slot = 0,
                                                                     std::uint16_t subslot = 1,
                                                                     std::optional<std::vector<std::uint16_t>> customIndices = std::nullopt) = 0;
 
  virtual Bytes PrmBegin() = 0;
 
  virtual Bytes PrmEnd() = 0;
 
  virtual Bytes ReadyForRtClass3() = 0;
 
  virtual Bytes ApplicationReady(double timeoutSec = 30.0) = 0;
 
  [[nodiscard]] virtual const dcp::DCPDeviceDescription& Info() const = 0;
 
  [[nodiscard]] virtual std::uint16_t LocalAlarmRef() const = 0;
 
  [[nodiscard]] virtual int DeviceAlarmRef() const = 0;
 
  [[nodiscard]] virtual bool HasAlarmCr() const = 0;
 
  [[nodiscard]] virtual std::vector<EPMEndpoint> EpmLookup(const std::string& ip, std::uint16_t port = RPC_PORT,
                                                           double timeoutSec = DEFAULT_TIMEOUT,
                                                           std::optional<std::string> interfaceFilter = std::nullopt) = 0;
};
 
} // namespace profinet::rpc