adtf::remote::ant::ISystem Class Reference

#include <adtf_remote_system_intf.h>

Inherited by adtf::remote::bat::ISystem.

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
virtual const char *	GetRPCIIDForObject (const char *strObject) const =0
virtual int8_t	GetRunlevel () const =0
virtual tResult	SetRunlevel (int8_t nRunLevel)=0
virtual const char *	GetLastErrorString () const =0
virtual tResult	Shutdown ()=0
virtual uint64_t	GetProcessID () const =0

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.

Member Function Documentation

GetLastErrorString()

virtual const char * adtf::remote::ant::ISystem::GetLastErrorString ( ) const

pure virtual

Retrieves the Last error String

Returns

NULL terminated string of the error string.

GetObjects()

virtual const char * adtf::remote::ant::ISystem::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 adtf::remote::ant::ISystem::GetProcessID ( ) const

pure virtual

Request the current process ID if system is available.

Returns

The Process ID of the ADTF System

Return values

-1	The system is not responding.

GetRPCIIDForObject()

virtual const char * adtf::remote::ant::ISystem::GetRPCIIDForObject ( const char * strObject ) const

pure virtual

Retrieves the RPC interface ID of given rpc object.

Parameters

[in]

strObject

The 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 adtf::remote::ant::ISystem::GetRunlevel ( ) const

pure virtual

Retrieves the current Runlevel of the System.

Returns

The current runlevel.

Return values

-1	The system is not responding.

See also

adtf::ucom::ant::IRuntime::GetRunlevel

SetRunlevel()

virtual tResult adtf::remote::ant::ISystem::SetRunlevel ( int8_t nRunLevel )

pure virtual

Request a runlevel change.

Parameters

[in]

nRunLevel

The runlevel to request.

Returns

The result of the IRuntime::SetRunlevel call.

Return values

ERR_NOT_CONNECTED

The system is not responding.

See also

adtf::ucom::ant::IRuntime::SetRunlevel

Shutdown()

virtual tResult adtf::remote::ant::ISystem::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_CONNECTED

The system is not responding.

---

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

• src/libraries/adtfremotesdk/include/adtfremotesdk/adtf_remote_system_intf.h