iRunnableQueue Struct Reference

Inheritance diagram for iRunnableQueue:

Detailed Description

Runnable queue interface.

Public Member Functions
virtual tU64	GetThreadID () const =0
	Get the runnable queue's owner thread. {Property}. More...
virtual tU32	GetSize () const =0
	Get the number of runnable currently in the queue. {Property}. More...
virtual tBool	IsEmpty () const =0
	Check whether any runnable is in the queue. More...
virtual tBool	Add (iRunnable *apRunnable)=0
	Queue a runnable. More...
virtual Ptr< iRunnable >	Peek ()=0
	Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty or if called from another thread than the owner thread. More...
virtual Ptr< iRunnable >	Poll ()=0
	Retrieves and removes the head of this queue, or returns null if this queue is empty or if called from another thread than the owner thread. More...
virtual tBool	WaitForRunnable (tU32 anTimeOut)=0
	Wait for a runnable to be in the queue. More...
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual tU64 GetThreadID ( ) const

pure virtual

Get the runnable queue's owner thread. {Property}.

virtual tU32 GetSize ( ) const

pure virtual

Get the number of runnable currently in the queue. {Property}.

virtual tBool IsEmpty ( ) const

pure virtual

Check whether any runnable is in the queue.

virtual tBool Add ( iRunnable *  apRunnable )

pure virtual

Queue a runnable.

Returns

eFalse if the queue is full, else eTrue.

virtual Ptr<iRunnable> Peek ( )

pure virtual

Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty or if called from another thread than the owner thread.

virtual Ptr<iRunnable> Poll ( )

pure virtual

Retrieves and removes the head of this queue, or returns null if this queue is empty or if called from another thread than the owner thread.

virtual tBool WaitForRunnable ( tU32  anTimeOut )

pure virtual

Wait for a runnable to be in the queue.

Returns

eFalse if the called from another thread than the other thread.