examples/Base/IPC/condvar/condvarlocal/src/queue.cpp

Go to the documentation of this file.

/*
Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of Nokia Corporation nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description:  Contains the definition of member functions of the CQueue class. 
*/



#include "queue.h"

CQueue* CQueue::NewL()
        {
        CQueue* self = new (ELeave)CQueue;
        CleanupStack::PushL(self);
        self->ConstructL();
        CleanupStack::Pop(self);
        return self;
        }

void CQueue::ConstructL()
        {
        // Create the local RMutex variable.
        User::LeaveIfError(iMutex.CreateLocal());
        // Create the local RCondVar variable.
        User::LeaveIfError(iCondVar.CreateLocal());
        }

CQueue::CQueue()
        {
        }

void CQueue::Insert()
        {
        // Wait for the mutex.
        // The mutex is required to ensure that only one thread updates iArray at a time.
        iMutex.Wait();
        // Insertion operation.
        // Insert some random number as a token into the queue.
        iArray.Append(Math::Random()%10);
        // Signal the local condition variable to indicate that queue has new data.
        iCondVar.Signal();
        // release the mutex so that the other thread has access to iArray.
        iMutex.Signal();
        // RCondVar::Broadcast() can be used as an alternative to the RCondVar::Signal() function.
        // It is more relevant to use Broadcast() when more than two threads are blocking on single condition variable.
        // The following code block illustrates the use of the Broadcast() function.
        //
        //if(!IsEmpty())
        //      {
        //      iCondVar.Broadcast();
        //      iMutex.Signal();
        //      }
        //
        }

void CQueue::Remove()
        {
        // Ensures that mutex is held by the current thread.
        iMutex.Wait();
        // Test to see whether there is anything in the queue before attempting to remove an item.
        // If the queue is empty wait for a signal on the Condition Variable before proceeding
        while(!IsEmpty())
                {
                // The following call blocks this thread and releases the mutex so that the other thread can update the shared data.
                // When the other thread signals iCondVar and releases the mutex this thread continues.  
                iCondVar.Wait(iMutex);
                // If there were more than one consumer waiting for the same signal
                // it would be essential to test IsEmpty() again because another thread, or threads,
                // might have got the mutex before this one and emptied the array.
                // For this reason if is good practise to use while( IsEmpty() ) instead of if( IsEmpty() ).
                }
        // Deletion operation.
        iArray.Remove(0);
        // Release the mutex.
        iMutex.Signal();
        }

TBool CQueue::IsEmpty()
        {
        if(iArray.Count() > 0)
                {
                return ETrue;
                }
        return EFalse;
        }

void CQueue::GetTokens(RArray<TInt>& aArray)
        {
        for(TInt ix = 0; ix < iArray.Count(); ix++)
                {
                aArray.Append(iArray[ix]);
                }
        }

CQueue::~CQueue()
        {
        iMutex.Close();
        iCondVar.Close();
        }

---