CINOSTimeEvent Class Reference

Inheritance diagram for CINOSTimeEvent:

Public Types
enum	{ eEventDisabled = 0 , eUsePreviousTime = 0 }

Public Member Functions
	CINOSTimeEvent (uint32 aTime)
void	Reset (uint32 aTime=eUsePreviousTime)
void	Stop ()
void	Start (uint32 aTime=eUsePreviousTime)
Public Member Functions inherited from CINOSSync
	CINOSSync (const char *aName=0, uint32 aInitialCount=0, bool aManual=false)
virtual	~CINOSSync ()
	Destroy sync object.
virtual const char *	GetName ()
	Get name of sync object.
virtual uint32	Wait (uint32 aTimeout=0xFFFFFFFF)
	wait for signaled state for max. aTimeout usec
virtual void	Signal ()
	Put object into the signaled state.
virtual void	SignalEx (CINOSTaskExMsg *apMsg, uint32 auRplId, uint32 auAppError)
virtual bool	MsgEvent (CINOSTaskExMsg *apMsg)
virtual void	Reset ()
	Reset object state.
volatile uint32 *	GetLockAdr ()
	Return pointer to core locking structure.
virtual bool	UsesPolling () const
bool	IsSame (CINOSSync *i_pSync)
int	operator< (const CINOSSync &aSync) const
int	operator== (const CINOSSync &aSync) const
int	operator< (const char *aName) const
int	operator== (const char *aName) const

Protected Member Functions
void	Handler ()
void	Cleanup ()
	DECLARE_DYNAMIC (CINOSTimeEvent)
Protected Member Functions inherited from CINOSSync
virtual bool	Signaled (CINOSSync *&aChild)
virtual CINOSSyncNode *	GetNode ()
virtual void	SetNode (CINOSSyncNode *aNode)
void	SignalAndUnlock (uint32 auMsr)
	Put object into the signaled state and release the core lock.

Protected Attributes
uint32	mWaitTime = eEventDisabled
CINOSxmsHandler *	pHandler = nullptr
CINOSExceptionCleanup *	pCleanup = nullptr
Protected Attributes inherited from CINOSSync
const char *	m_pName
	name of sync object
uint32	m_uCount
	signaled count of object
bool	m_bManual
	manual object yes/no
tTaskId	m_idFstWaiting
	id of first task waiting for the sync object
tTaskId	m_idLstWaiting
	id of last task waiting for the sync object
SINOSCoreLock	m_Lock
	core lock
CINOSSyncNode *	m_pNode
	pointer to object node (if any)

Constructor & Destructor Documentation

CINOSTimeEvent()

CINOSTimeEvent::CINOSTimeEvent

(

uint32

aTime

)

Create time event with aTime in [ms].

Parameters

aTime

The time until this event is being signaled in [ms]. if using 0, this event is disabled/inactive and will NOT be signaled.

Member Function Documentation

Stop()

void CINOSTimeEvent::Stop

(

)

remove 1ms handler and reset sync object. The 'wait time' for this time event will be kept, so that a follow-up call to Reset or Start with aTime=0 will re-trigger this time event with the previously used event time.

---

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

• /home/jenkins/workspace/inos_doxygen/os/inos/inc/inos_syn.h