adtf::remote::cADTFRemoteSystem Class Reference

#include <adtf_remote_system.h>

Public Member Functions
	cADTFRemoteSystem (const char *strHostUrl)
	~cADTFRemoteSystem ()
adtf::util::cStringList	FindObjectsByRPCIID (const char *strRPCIID) const
tResult	GetObjectClient (const char *strObject, IRPCObjectClientPtr &oClient) const
tResult	Ping () const
uint64_t	GetProcessID () const
adtf::util::cString	GetHostURL () const

Static Public Attributes
static constexpr const char *const	DEFAULT_HOST_URL = ADTF_REMOTE_DEFAULT_HOST_URL

Protected Member Functions
	cADTFRemoteSystem ()
	CTOR.

Detailed Description

Default ADTF RPC Client Factory to create Json Object Clients! This factory can will create the Default Clients to communicate with a ADTF instance.

Constructor & Destructor Documentation

cADTFRemoteSystem()

adtf::remote::ant::cADTFRemoteSystem::cADTFRemoteSystem ( const char * strHostUrl )

explicit

CTOR.

Parameters

[in]

strHostUrl

Host URL of the ADTF System. By default the DEFAULT_HOST_URL will be used.

~cADTFRemoteSystem()

adtf::remote::ant::cADTFRemoteSystem::~cADTFRemoteSystem

(

)

DTOR.

Member Function Documentation

FindObjectsByRPCIID()

adtf::util::cStringList adtf::remote::ant::cADTFRemoteSystem::FindObjectsByRPCIID

(

const char *

strRPCIID

)

const

Retrieves a list of objectnames registered within the adtf::services::ant::IRPCObjectServerRegistry on server side which supports the given strRPCIID rpc interface id.

Parameters

[in]

strRPCIID

The rpc interface id to look for.

Returns

The list of object names.

GetHostURL()

adtf::util::cString adtf::remote::ant::cADTFRemoteSystem::GetHostURL

(

)

const

Gets the current Host URL.

Returns

The value of the ADTF System Host URL.

GetObjectClient()

tResult adtf::remote::ant::cADTFRemoteSystem::GetObjectClient	(	const char *	strObject,
		IRPCObjectClientPtr &	oClient ) const

Retrieves an implementation of a IRPCObjectClient for the given object if supported.

Following interfaces are supported:

• adtf::remote::ant::ISystem
• adtf::remote::ant::ISession
• adtf::remote::ant::IClock
• adtf::remote::ant::IRecorder
• adtf::remote::ant::IPlayer
• adtf::remote::quiet::ISampleStreamTracer

Use as follows:

cADTFRemoteSystem oADTFSystem(cADTFRemoteSystem::DEFAULT_HOST_URL);
adtf::remote::rpc_object_client_ptr<adtf::remote::ISystem> pSystem;
if (IS_OK(oADTFSystem.GetObjectClient(adtf::remote::ISystem::DEFAULT_NAME, pSystem)))
{
     int8_t i8CurrentRunlevel = pSystem->GetRunlevel();
}

Parameters

[in]	strObject	Object name
[in]	oClient	Implementation of IRPCObjectClientPtr to retrieve the IRPCObjectClient to. See also rpc_object_client_ptr

Returns

Result Code of IRPCObjectClientPtr if object and supported interface is found.

Return values

ERR_NOT_SUPPORTED	Interface is not supported
ERR_NOT_FOUND	Object is not found

Remarks

As IRPCObjectClientPtr uses std::shared_ptr this is NOT binary compatible!

GetProcessID()

uint64_t adtf::remote::ant::cADTFRemoteSystem::GetProcessID

(

)

const

Get Process ID

Returns

return the current proc id of the far system.

Ping()

tResult adtf::remote::ant::cADTFRemoteSystem::Ping

(

)

const

Requests a response of the ADTF Remote System. Use to check if a system is available on the given URL.

Return values

ERR_NOERROR	ADTF is available.
ERR_NOT_CONNECTED	ADTF Remote System did not response.

Member Data Documentation

DEFAULT_HOST_URL

const char* const adtf::remote::ant::cADTFRemoteSystem::DEFAULT_HOST_URL = ADTF_REMOTE_DEFAULT_HOST_URL

staticconstexpr

ADTF System Launcher default JSon Server Address.

See also

ADTF_REMOTE_DEFAULT_HOST_URL

---

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

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