ADTF  3.18.2
ISystemabstract

Interface of the ADTF System RPC object server. More...

Inheritance diagram for ISystem:
[legend]

Public Member Functions

 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...
 

Static Public Attributes

static constexpr const tChar *const DEFAULT_NAME = "system"
 Default RPC object server name of the ADTF System RPC object server.
 

Detailed Description

Interface of the ADTF System RPC object server.

See also
cADTFRemoteSystem.

Definition at line 24 of file adtf_remote_system_intf.h.

Member Function Documentation

◆ GetLastErrorString()

virtual const char* GetLastErrorString ( ) const
pure virtual

Retrieves the Last error String.

Returns
NULL terminated string of the error string.

◆ GetObjects()

virtual const char* GetObjects ( ) const
pure virtual

Retrieves a comma separated list of rpc object names currently registered within the the adtf::services::ant::IRPCObjectServerRegistry.

Returns
NULL terminated string with a comma separated list of object names.

◆ GetProcessID()

virtual uint64_t GetProcessID ( ) const
pure virtual

Request the current process ID if system is available.

Returns
The Process ID of the ADTF System
Return values
-1The system is not responding.

◆ GetRPCIIDForObject()

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

Retrieves the RPC interface ID of given rpc object.

Parameters
[in]strObjectThe RPC object server name.
Returns
NULL terminated stringof the RPCIID.
Return values
<empty>The object is not avaiblable within the system.

◆ GetRunlevel()

virtual int8_t GetRunlevel ( ) const
pure virtual

Retrieves the current Runlevel of the System.

Returns
The current runlevel.
Return values
-1The system is not responding.
See also
adtf::ucom::ant::IRuntime::GetRunlevel

◆ SetRunlevel()

virtual tResult SetRunlevel ( int8_t  nRunLevel)
pure virtual

Request a runlevel change.

Parameters
[in]nRunLevelThe runlevel to request.
Returns
The result of the IRuntime::SetRunlevel call.
Return values
ERR_NOT_CONNECTEDThe system is not responding.
See also
adtf::ucom::ant::IRuntime::SetRunlevel

◆ Shutdown()

virtual tResult Shutdown ( )
pure virtual

Request a runlevel change to shutdown and exit the System.

Returns
The result of the IRuntime::SetRunlevel call.
Return values
ERR_NOT_CONNECTEDThe system is not responding.