ADTF  3.14.3
IApplicationabstract

The IApplication interface wraps a generic processing loop. More...

Inheritance diagram for IApplication:
[legend]

Classes

class  IJob
 Job to add to the applications queue. More...
 

Public Member Functions

 ADTF_IID (IApplication, "application.ant.services.adtf.iid")
 definition of iid
 
virtual tResult Exec ()=0
 Application main function. More...
 
virtual tResult Exit (tResult oExitResult=ERR_NOERROR)=0
 Stops the application. More...
 
virtual tResult EnqueueJob (const ucom::ant::iobject_ptr< IJob > &oJob, bool bWait)=0
 Queues the job to the the applications queue processing. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Additional Inherited Members

- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

The IApplication interface wraps a generic processing loop.

Definition at line 23 of file application_intf.h.

Member Function Documentation

◆ EnqueueJob()

virtual tResult EnqueueJob ( const ucom::ant::iobject_ptr< IJob > &  oJob,
bool  bWait 
)
pure virtual

Queues the job to the the applications queue processing.

This job must be executed within the main thread.

Parameters
[in]oJobthe job to call the Run(adtf::base::ant::IRunnable::RUN_JOB) to.
[in]bWaitenables waiting until job was executed.
Returns
Standard Result Value

◆ Exec()

virtual tResult Exec ( )
pure virtual

Application main function.

Returns
Will return the oExitResult of the Exit method.

◆ Exit()

virtual tResult Exit ( tResult  oExitResult = ERR_NOERROR)
pure virtual

Stops the application.

Parameters
oExitResult[in] the return code that the applications Exec function return.
Return values
ERR_NOERRORExit Code was set. Blocking Exec return.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)