adtf::ucom::ant::ILockedObject Class Reference

#include <lockedobject_intf.h>

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

Inherited by adtf::ucom::ant::ISharedLockedObject.

Public Member Functions
	ADTF_IID (ILockedObject, "lockedobject.ant.ucom.adtf.iid")
virtual tResult	Lock () const =0
virtual tResult	Unlock () const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

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

Detailed Description

The ILockedObject interface defines exclusive locking of an object.

Member Function Documentation

ADTF_IID()

adtf::ucom::ant::ILockedObject::ADTF_IID	(	ILockedObject	,
		"lockedobject.ant.ucom.adtf.iid"	)

Marks the ILockedObject to be castable with the ucom_cast<>

See also

ADTF_IID(_interface, _striid)

Lock()

virtual tResult adtf::ucom::ant::ILockedObject::Lock ( ) const

pure virtual

Locks the object for exclusive use. For your own convinience use object_ptr_locked as lock guard!

Return values

ERR_NOERROR

succeeded lock. DO NOT Forget to unlock!

Unlock()

virtual tResult adtf::ucom::ant::ILockedObject::Unlock ( ) const

pure virtual

Unlocks the object for exclusive use. For your own convinience use object_ptr_locked as lock guard!

Return values

ERR_NOERROR

succeeded unlock.

---

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

• src/libraries/ucom3/include/adtfucom3/interfaces/lockedobject_intf.h