The TraceController provides an Interface to manage and control the LTTng Tracing on the Control More...

#include <ITraceControllerService.hpp>

Inheritance diagram for Arp::Services::TraceController::Services::ITraceControllerService:

Public Types
typedef std::shared_ptr< ITraceControllerService >	Ptr

Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

Public Member Functions
	ITraceControllerService (void)
	Constructs an ITraceControllerService instance. More...

virtual	~ITraceControllerService (void)
	Destructs this instance and frees all resouces. More...

virtual boolean	IsSessionDaemonAlive ()=0
	Checks if the session daemon for tracing is alive. More...

virtual boolean	LoadSessionConfiguration (const RscString< 512 > &session, const RscString< 512 > &path)=0
	Tries to loads a configuration file. More...

virtual std::vector< RscString< 512 > >	ListSessions ()=0
	Queries a list of loaded LTTng Sessions More...

virtual boolean	StartSession (const RscString< 512 > &session)=0
	Starts an LTTnG Trace Session More...

virtual boolean	StopSession (const RscString< 512 > &session)=0
	Stops an LTTnG Trace Session More...

virtual boolean	DestroySession (const RscString< 512 > &session)=0
	Destroys/Unloads an LTTnG Trace Session More...

virtual void	LoadTracepointLib ()=0
	Loads the userspace Trace-Point-Library More...

virtual void	UnloadTracepointLib ()=0
	Unoads the userspace Trace-Point-Library More...

virtual boolean	TriggerSavingTraceOutputs (boolean stopTriggerSession)=0
	Records/Saves all outputs of a configured session after an internal timeout delay Session in Snapshotmode: - A session snapshot will be recorded and the snapshot will then moved to the recording output directory. More...

virtual boolean	IsSessionInSnapshotMode (const RscString< 512 > &session)=0
	Checks if a trace session is in Snapshot Mode More...

virtual boolean	IsSessionEnabled (const RscString< 512 > &session)=0
	Checks if a trace session is already enabled/started More...

virtual boolean	IsSessionLoaded (const RscString< 512 > &session)=0
	Checks if a trace session is already loaded More...

Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
	IRscService (void)=default
	Constructs an IRscService instance. More...

virtual	~IRscService (void)=default
	Destructs this instance and frees all resouces. More...

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)

Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of the service More...

Detailed Description

The TraceController provides an Interface to manage and control the LTTng Tracing on the Control

Constructor & Destructor Documentation

◆ ITraceControllerService()

Arp::Services::TraceController::Services::ITraceControllerService::ITraceControllerService ( void )

inline

Constructs an ITraceControllerService instance.

◆ ~ITraceControllerService()

Arp::Services::TraceController::Services::ITraceControllerService::~ITraceControllerService ( void )

inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

◆ DestroySession()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::DestroySession ( const RscString< 512 > & session )

pure virtual

Destroys/Unloads an LTTnG Trace Session

Parameters

session Name of Session which will be destroyed/unloaded

Returns: True when the the Session is destroyed/unloaded successfull, otherwise false is returned

"VeException: when session does not exist or an lttng-error is occured."

◆ IsSessionDaemonAlive()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::IsSessionDaemonAlive ( )

pure virtual

Checks if the session daemon for tracing is alive.

Returns: True if session daemon is running otherwise false is returned.

◆ IsSessionEnabled()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::IsSessionEnabled ( const RscString< 512 > & session )

pure virtual

Checks if a trace session is already enabled/started

Parameters

session Session Name, which mode will be checked

Returns: True if the session is in enabled/started, otherwise false is returned

"VeException: when session does not exist or an lttng-error is occured."

◆ IsSessionInSnapshotMode()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::IsSessionInSnapshotMode ( const RscString< 512 > & session )

pure virtual

Checks if a trace session is in Snapshot Mode

Parameters

session Session Name, which mode will be checked

Returns: True if the session is in Snapshot Mode, otherwise false is returned

"VeException: when session does not exist or an lttng-error is occured."

◆ IsSessionLoaded()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::IsSessionLoaded ( const RscString< 512 > & session )

pure virtual

Checks if a trace session is already loaded

Parameters

session Session Name, which mode will be checked

Returns: True if the session is in loaded, otherwise false is returned

"VeException: when an lttng-error is occured."

◆ ListSessions()

virtual std::vector<RscString<512> > Arp::Services::TraceController::Services::ITraceControllerService::ListSessions ( )

pure virtual

Queries a list of loaded LTTng Sessions

Returns: list with names of loaded LTTng Sessions

"VeException: when an lttng-error is occured."

◆ LoadSessionConfiguration()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::LoadSessionConfiguration	(	const RscString< 512 > &	session,
		const RscString< 512 > &	path
	)

pure virtual

Tries to loads a configuration file.

Parameters

session	Session Name, which much be identical with the trace name configured in the .lttng
path	path to the .lttng configuration file of the session

Returns: True when the session is loaded successfull, otherwise false

"VeException: when session is already loaded or an lttng-error is occured."

◆ LoadTracepointLib()

virtual void Arp::Services::TraceController::Services::ITraceControllerService::LoadTracepointLib ( )

pure virtual

Loads the userspace Trace-Point-Library

"InvalidConfigException: path to library does not exist." "InvalidOperationException: TracepointLib ist already loaded" "VeException: when an error occured during loading the shared library

◆ StartSession()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::StartSession ( const RscString< 512 > & session )

pure virtual

Starts an LTTnG Trace Session

Parameters

session Name of Session which will be started

Returns: True when the the Session is started successfull, otherwise false is returned

"VeException: when session is already started, does not exist or an lttng-error is occured."

◆ StopSession()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::StopSession ( const RscString< 512 > & session )

pure virtual

Stops an LTTnG Trace Session

Parameters

session Name of Session which will be stopped

Returns: True when the the Session is stopped successfull, otherwise false is returned

"VeException: when session is already stopped, does not exist or an lttng-error is occured."

◆ TriggerSavingTraceOutputs()

virtual boolean Arp::Services::TraceController::Services::ITraceControllerService::TriggerSavingTraceOutputs ( boolean stopTriggerSession )

pure virtual

Records/Saves all outputs of a configured session after an internal timeout delay Session in Snapshotmode: - A session snapshot will be recorded and the snapshot will then moved to the recording output directory.

All old outputs will be deleted Session not in Snapshotmode: The Trace session output will be copied to the recording output directory

Returns: True when the recording was successfull, otherwise false is returned

◆ UnloadTracepointLib()

virtual void Arp::Services::TraceController::Services::ITraceControllerService::UnloadTracepointLib ( )

pure virtual

Unoads the userspace Trace-Point-Library

"VeException: error occured during unloading the lib." "InvalidConfigException: when path to the TracepointLib cannot be resolved" "InvalidOperationException: when a lttng session still running"

The documentation for this class was generated from the following file:

Arp/Services/TraceController/Services/ITraceControllerService.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ITraceControllerService()

◆ ~ITraceControllerService()

Member Function Documentation

◆ DestroySession()

◆ IsSessionDaemonAlive()

◆ IsSessionEnabled()

◆ IsSessionInSnapshotMode()

◆ IsSessionLoaded()

◆ ListSessions()

◆ LoadSessionConfiguration()

◆ LoadTracepointLib()

◆ StartSession()

◆ StopSession()

◆ TriggerSavingTraceOutputs()

◆ UnloadTracepointLib()