ADTF  3.18.2
ISystemabstract
Inheritance diagram for ISystem:
[legend]

Public Member Functions

 ADTF_IID (ISystem, "system.catwo.remote.adtf")
 RPC interface ID of the ADTF System RPC object server.
 
virtual int CreateEventBuffer (const char *strObject, const char *strStructName, const char *strDDL)=0
 Creates a new event buffer. More...
 
virtual tResult ReleaseEventBuffer (int nBufferID)=0
 Releases an event buffer and all associated resources. More...
 
virtual tResult ReleaseAllEventBuffers ()=0
 Releases all currently available event buffers and all associated resources. More...
 
virtual const char * RetrieveEvents (int nBufferID)=0
 Returns a string representation of all events since the last call. More...
 
virtual const char * GetInterfaceDefinition (const char *strObject)=0
 Returns the interface definition of the given RPC object. More...
 
- Public Member Functions inherited from ISystem
 ADTF_IID (ISystem, "system.bat.remote.adtf")
 RPC interface ID of the ADTF System RPC object server.
 
virtual const char * GetRPCIIDsForObject (const char *strObject) const =0
 Retrieves the RPC interfaces of a given rpc object. More...
 
- Public Member Functions inherited from ISystem
 ADTF_IID (ISystem, "system.ant.remote.adtf")
 RPC interface ID of the ADTF System RPC object server.
 
virtual const char * GetObjects () const =0
 Retrieves a comma separated list of rpc object names currently registered within the the adtf::services::ant::IRPCObjectServerRegistry. More...
 
virtual const char * GetRPCIIDForObject (const char *strObject) const =0
 Retrieves the RPC interface ID of given rpc object. More...
 
virtual int8_t GetRunlevel () const =0
 Retrieves the current Runlevel of the System. More...
 
virtual tResult SetRunlevel (int8_t nRunLevel)=0
 Request a runlevel change. More...
 
virtual const char * GetLastErrorString () const =0
 Retrieves the Last error String. More...
 
virtual tResult Shutdown ()=0
 Request a runlevel change to shutdown and exit the System. More...
 
virtual uint64_t GetProcessID () const =0
 Request the current process ID if system is available. More...
 

Additional Inherited Members

- Static Public Attributes inherited from ISystem
static constexpr const tChar *const DEFAULT_NAME = "system"
 Default RPC object server name of the ADTF System RPC object server.
 

Detailed Description

Definition at line 124 of file adtf_remote_system_intf.h.

Member Function Documentation

◆ CreateEventBuffer()

virtual int CreateEventBuffer ( const char *  strObject,
const char *  strStructName,
const char *  strDDL 
)
pure virtual

Creates a new event buffer.

Parameters
[in]strObjectThe object id of the event source.
[in]strStructNameThe struct name of the struct from the ddl that describes the event data.
[in]strDDLThe DDL of the event data.
Returns
A new buffer ID or -1 in case of failure.

◆ GetInterfaceDefinition()

virtual const char* GetInterfaceDefinition ( const char *  strObject)
pure virtual

Returns the interface definition of the given RPC object.

Parameters
[in]strObjectThe name of the RPC object.

◆ ReleaseAllEventBuffers()

virtual tResult ReleaseAllEventBuffers ( )
pure virtual

Releases all currently available event buffers and all associated resources.

Returns
Standard result.

◆ ReleaseEventBuffer()

virtual tResult ReleaseEventBuffer ( int  nBufferID)
pure virtual

Releases an event buffer and all associated resources.

Parameters
[in]nBufferID
Returns
Standard result.

◆ RetrieveEvents()

virtual const char* RetrieveEvents ( int  nBufferID)
pure virtual

Returns a string representation of all events since the last call.

Parameters
[in]nBufferID
Returns
Each line represents an event in the format <timestamp>:<value1>,<value2>,...,<valueN>