PLCnext API Documentation  22.9.0.33
ITraceControllerService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include <vector>
9 #include "Arp/Services/TraceController/Services/TraceControllerServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/IRscService.hpp"
11 #include "Arp/System/Rsc/Services/RscString.hxx"
12 
13 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ITraceControllerService.cs
14 
15 namespace Arp { namespace Services { namespace TraceController { namespace Services
16 {
17 
18 using namespace Arp;
19 using namespace Arp::System::Rsc::Services;
20 
26 {
27 public: // typedefs
28  using Ptr = std::shared_ptr<ITraceControllerService>;
29 
30 public: // construction/destruction
32  ITraceControllerService(void) = default;
33 
34 public: // static policy operation
35  static IRscServiceProxyFactory& GetProxyFactory(void);
36 
37 public: // abstract operations
42  virtual boolean IsSessionDaemonAlive() = 0;
43 
51  virtual boolean LoadSessionConfiguration(const RscString<512>& session, const RscString<512>& path) = 0;
52 
58  virtual std::vector<RscString<512>> ListSessions() = 0;
59 
66  virtual boolean StartSession(const RscString<512>& session) = 0;
67 
74  virtual boolean StopSession(const RscString<512>& session) = 0;
75 
82  virtual boolean DestroySession(const RscString<512>& session) = 0;
83 
92  virtual void LoadTracepointLib() = 0;
93 
102  virtual void UnloadTracepointLib() = 0;
103 
111  virtual boolean TriggerSavingTraceOutputs(boolean stopTriggerSession) = 0;
112 
119  virtual boolean IsSessionInSnapshotMode(const RscString<512>& session) = 0;
120 
127  virtual boolean IsSessionEnabled(const RscString<512>& session) = 0;
128 
135  virtual boolean IsSessionLoaded(const RscString<512>& session) = 0;
136 };
137 
139 // inline methods of class ITraceControllerService
140 inline IRscServiceProxyFactory& ITraceControllerService::GetProxyFactory()
141 {
142  return TraceControllerServiceProxyFactory::GetInstance();
143 }
144 
145 }}}} // end of namespace Arp::Services::TraceController::Services
The TraceController provides an Interface to manage and control the LTTng Tracing on the Control
Definition: ITraceControllerService.hpp:26
virtual boolean IsSessionDaemonAlive()=0
Checks if the session daemon for tracing is alive.
virtual boolean DestroySession(const RscString< 512 > &session)=0
Destroys/Unloads an LTTnG Trace Session
virtual boolean IsSessionEnabled(const RscString< 512 > &session)=0
Checks if a trace session is already enabled/started
virtual boolean IsSessionInSnapshotMode(const RscString< 512 > &session)=0
Checks if a trace session is in Snapshot Mode
ITraceControllerService(void)=default
Constructs an ITraceControllerService instance.
virtual void UnloadTracepointLib()=0
Unoads the userspace Trace-Point-Library
virtual std::vector< RscString< 512 > > ListSessions()=0
Queries a list of loaded LTTng Sessions
virtual boolean StopSession(const RscString< 512 > &session)=0
Stops an LTTnG Trace 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 configuration file.
virtual boolean TriggerSavingTraceOutputs(boolean stopTriggerSession)=0
Records/Saves all outputs of a configured session after an internal timeout delay Session in Snapshot...
virtual void LoadTracepointLib()=0
Loads the userspace Trace-Point-Library
virtual boolean StartSession(const RscString< 512 > &session)=0
Starts an LTTnG Trace Session
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API