PLCnext API Documentation 26.6.0.38
ITraceControllerService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include <vector>
11#include "Arp/Base/Rsc/Commons/RscString.hxx"
12
13// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ITraceControllerService.cs
14
16{
17
18using namespace Arp::Base::Rsc::Commons;
19
47class ARP_EXPORT ITraceControllerService : public IRscService
48{
49public: // usings
50 using Ptr = std::shared_ptr<ITraceControllerService>;
51
52public: // construction/destruction
54 ITraceControllerService(void) = default;
55
56public: // static policy operation
57 static IRscServiceProxyFactory& GetProxyFactory(void);
58
59public: // abstract operations
69 virtual boolean IsSessionDaemonAlive() = 0;
70
100 virtual boolean LoadSessionConfiguration(const RscString<512>& session, const RscString<512>& path) = 0;
101
107 virtual std::vector<RscString<512>> ListSessions() = 0;
108
125 virtual boolean StartSession(const RscString<512>& session) = 0;
126
139 virtual boolean StopSession(const RscString<512>& session) = 0;
140
154 virtual boolean DestroySession(const RscString<512>& session) = 0;
155
165 virtual void LoadTracepointLib() = 0;
166
176 virtual void UnloadTracepointLib() = 0;
177
194 virtual boolean TriggerSavingTraceOutputs(boolean stopTriggerSession) = 0;
195
215 virtual boolean IsSessionInSnapshotMode(const RscString<512>& session) = 0;
216
227 virtual boolean IsSessionEnabled(const RscString<512>& session) = 0;
228
236 virtual boolean IsSessionLoaded(const RscString<512>& session) = 0;
237};
238
239} // end of namespace Arp::Services::TraceController::Services
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
This service provides an Interface to manage and control the LTTng tracing on the PLCnext controller.
Definition: ITraceControllerService.hpp:48
virtual std::vector< RscString< 512 > > ListSessions()=0
Queries a list of all loaded (both started and stopped sessions) LTTng tracing sessions.
virtual boolean IsSessionDaemonAlive()=0
Checks if the LTTng session daemon for tracing is alive.
virtual boolean DestroySession(const RscString< 512 > &session)=0
Destroys/Unloads a LTTng tracing session.
virtual boolean IsSessionEnabled(const RscString< 512 > &session)=0
Checks if a tracing session is already enabled/started.
virtual boolean IsSessionInSnapshotMode(const RscString< 512 > &session)=0
Checks if a tracing session is in Snapshot Mode.
ITraceControllerService(void)=default
Constructs an ITraceControllerService instance.
virtual void UnloadTracepointLib()=0
Unloads the userspace Tracepoint library.
virtual boolean StopSession(const RscString< 512 > &session)=0
Stops a LTTng tracing session.
virtual boolean IsSessionLoaded(const RscString< 512 > &session)=0
Checks if a trace session is already loaded.
virtual boolean LoadSessionConfiguration(const RscString< 512 > &session, const RscString< 512 > &path)=0
Tries to loads a tracing session from a given configuration file.
virtual boolean TriggerSavingTraceOutputs(boolean stopTriggerSession)=0
Triggers the recording/saving all outputs of a configured session. Saving will be performed by anothe...
virtual void LoadTracepointLib()=0
Loads the PLCnext userspace Tracepoint library.
virtual boolean StartSession(const RscString< 512 > &session)=0
Starts a LTTng tracing session.
Namespace for services of the TraceController