ADTF
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
adtf::services::ant::IApplication Class Referenceabstract

#include <application_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::services::quiet::IApplication.

Classes

class  IJob
 

Public Member Functions

 ADTF_IID (IApplication, "application.ant.services.adtf.iid")
 definition of iid
 
virtual tResult Exec ()=0
 
virtual tResult Exit (tResult oExitResult=ERR_NOERROR)=0
 
virtual tResult EnqueueJob (const ucom::ant::iobject_ptr< IJob > &oJob, bool bWait)=0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Additional Inherited Members

- Protected Member Functions inherited from adtf::ucom::ant::IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 

Detailed Description

The IApplication interface wraps a generic processing loop.

Member Function Documentation

◆ EnqueueJob()

virtual tResult adtf::services::ant::IApplication::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 adtf::services::ant::IApplication::Exec ( )
pure virtual

Application main function.

Returns
Will return the oExitResult of the Exit method.

◆ Exit()

virtual tResult adtf::services::ant::IApplication::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.
The documentation for this class was generated from the following file: