diff -r 89d6a7a84779 -r 25a17d01db0c Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_consumer.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_consumer.html Fri Jan 22 18:26:19 2010 +0000 @@ -0,0 +1,213 @@ + + +TB10.1 Example Applications: CConsumer Class Reference + + + + +

CConsumer Class Reference

+

+List of all members. + + + + + + + + + + + + + + + + + +

Public Member Functions

void ConstructL (CConsoleBase *aConsole, CQueue *aTokens)
void ResumeCons ()
+void Consume ()
 ~CConsumer ()

Static Public Member Functions

static CConsumer * NewL (CConsoleBase *aConsole, CQueue *aTokens)
static TInt ConsThreadFunc (TAny *aPtr)
static TInt RemoveFunction (TAny *aPtr)
+

Detailed Description

+This class owns the consumer thread. It provides an interface to remove tokens from the CQueue::iArray queue.
See also:
CQueue.

+CPeriodic.

+ +

Definition at line 34 of file consumer.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
CConsumer::~CConsumer (  ) 
+
+
+ +

+Destructor. +

Definition at line 111 of file consumer.cpp.

+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
CConsumer * CConsumer::NewL (CConsoleBase *  aConsole,
CQueue *  aTokens 
) [static]
+
+
+ +

+Performs the two-phase construction of an object of the CConsumer class.

Parameters:
+ + + +
aConsole The console object.
aTokens A pointer to the CQueue object containing the tokens' queue.
+
+
Returns:
A CConsumer object.
+ +

Definition at line 31 of file consumer.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void CConsumer::ConstructL (CConsoleBase *  aConsole,
CQueue *  aTokens 
)
+
+
+ +

+The second phase constructor of the CConsumer class. It creates the following member objects of the class:

+ +

Definition at line 51 of file consumer.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
TInt CConsumer::ConsThreadFunc (TAny *  aPtr  )  [static]
+
+
+ +

+The consumer thread function. It removes a token from the queue.

Parameters:
+ + +
aPtr A pointer to the arguments passed to the thread function.
+
+ +

Definition at line 82 of file consumer.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CConsumer::ResumeCons (  ) 
+
+
+ +

+Resumes the execution of the consumer thread. +

Definition at line 101 of file consumer.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
TInt CConsumer::RemoveFunction (TAny *  aPtr  )  [static]
+
+
+ +

+The call back function associated with the CPeriodic object of the CConsumer class.

See also:
CConsumer::ConstructL().

+CPeriodic.

+ +

Definition at line 123 of file consumer.cpp.

+ +
+

+

Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by  + +doxygen 1.5.3
+ +