sl@0: // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32/include/e32msgqueue.inl
sl@0: // 
sl@0: //
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: template <typename T>
sl@0: inline TInt RMsgQueue<T>::CreateLocal(TInt aSize, TOwnerType aOwner)
sl@0: /**
sl@0: Creates a message queue that is private to the current process,
sl@0: and opens a handle to that message queue.
sl@0: 
sl@0: The size of each message in the queue is the size of the template
sl@0: parameter type. 
sl@0: This must conform to the restrictions imposed on the aMsgLength parameter
sl@0: passed to the base class function RMsgQueueBase::CreateLocal().
sl@0: 
sl@0: @param aSize      The number of message 'slots' in the queue.
sl@0:                   This must be a positive value, i.e. greater than zero.
sl@0: @param aOwner     The type of handle to be created.
sl@0:                   EOwnerProcess is the default value, if not explicitly specified.
sl@0: 
sl@0: @return KErrNone if the queue is created sucessfully, otherwise one of
sl@0:         the other system wide error codes.
sl@0: 
sl@0: @panic KERN-EXEC 49 if aSize is less than or equal to zero.
sl@0: @panic KERN-EXEC 48 if the size of the template parameter type is not
sl@0:        a multiple of 4 bytes, is less than 4, or is greater than KMaxLength.
sl@0: 
sl@0: @see RMsgQueueBase::CreateLocal
sl@0: @see KMaxLength
sl@0: */
sl@0: 	{return RMsgQueueBase::CreateLocal(aSize, sizeof(T), aOwner);}
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: template <typename T>
sl@0: inline TInt RMsgQueue<T>::CreateGlobal(const TDesC& aName, TInt aSize, TOwnerType aOwner)
sl@0: /**
sl@0: Creates a global message queue, and opens a handle to that
sl@0: message queue.
sl@0: 
sl@0: If the name is non-empty, the message queue is visible to all processes.
sl@0: If the name is empty it cannot be opened or searched for by name, but a handle
sl@0: to it can be passed to another process as a process parameter or via IPC.
sl@0: 
sl@0: The size of each message in the queue is the size of the template
sl@0: parameter type. 
sl@0: This must conform to the restrictions imposed on the aMsgLength parameter
sl@0: passed to the base class function RMsgQueueBase::CreateGlobal().
sl@0: 
sl@0: @param aName  The name to be assigned to the message queue.
sl@0: @param aSize  The number of message 'slots' in the queue.
sl@0:               This must be a positive value, i.e. greater than zero.
sl@0: @param aOwner The type of handle to be created.
sl@0:               EOwnerProcess is the default value, if not explicitly specified.
sl@0: 
sl@0: @return KErrNone if the queue is created sucessfully, otherwise one of
sl@0:         the other system wide error codes.
sl@0: 
sl@0: @panic KERN-EXEC 49 if aSize is less than or equal to zero.
sl@0: @panic KERN-EXEC 48 if the size of the template parameter type is not
sl@0:        a multiple of 4 bytes, is less than 4, or is greater than KMaxLength.
sl@0: 
sl@0: @see RMsgQueueBase::CreateGlobal
sl@0: @see KMaxLength
sl@0: */
sl@0: 	{return RMsgQueueBase::CreateGlobal(aName, aSize, sizeof(T), aOwner);}
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: //realtime
sl@0: template <typename T>
sl@0: inline TInt RMsgQueue<T>::Send(const T& aMessage)
sl@0: /**
sl@0: 
sl@0: Sends a message through this queue.
sl@0: 
sl@0: The function does not wait (i.e. block), if the queue is full.
sl@0: 
sl@0: The function is implemented through a call to 
sl@0: RMsgQueueBase::Send().
sl@0:   
sl@0: @param aMessage The message data to be sent.
sl@0: 
sl@0: @return KErrNone, if successful;
sl@0:         KErrOverflow, if queue is full,
sl@0: 
sl@0: @see RMsgQueueBase::Send
sl@0: */
sl@0: 	{return RMsgQueueBase::Send(&aMessage, sizeof(T));}
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: template <typename T>
sl@0: inline void RMsgQueue<T>::SendBlocking(const T& aMessage)
sl@0: /**
sl@0: Sends a message through this queue, and waits for space to become available 
sl@0: if the queue is full.
sl@0: 
sl@0: The function uses NotifySpaceAvailable() to provide the blocking operation. 
sl@0: Note that it is not possible to cancel a call to SendBlocking().
sl@0: 
sl@0: The function is implemented through a call to 
sl@0: RMsgQueueBase::SendBlocking().
sl@0: 
sl@0: @param aMessage The message data to be sent.
sl@0: 
sl@0: @see RMsgQueueBase::SendBlocking
sl@0: */
sl@0: 	{RMsgQueueBase::SendBlocking(&aMessage, sizeof(T));}
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: //realtime
sl@0: template <typename T>
sl@0: inline TInt RMsgQueue<T>::Receive(T& aMessage)
sl@0: /**
sl@0: 
sl@0: Retrieves the first message in the queue.
sl@0: 
sl@0: The function does not wait (i.e. block), if the queue is empty.
sl@0: 
sl@0: The function is implemented through a call to 
sl@0: RMsgQueueBase::Receive().
sl@0: 
sl@0: @param aMessage The object into which the message is retrieved.
sl@0: 
sl@0: @return KErrNone, ifsuccessful;
sl@0:         KErrUnderflow, if the queue is empty.
sl@0: 
sl@0: @see RMsgQueueBase::Receive
sl@0: */
sl@0: 	{return RMsgQueueBase::Receive(&aMessage, sizeof(T));}
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: template <typename T>
sl@0: inline void RMsgQueue<T>::ReceiveBlocking(T& aMessage)
sl@0: /**
sl@0: Retrieves the first message in the queue, and waits if the queue is empty.
sl@0: 
sl@0: The function uses NotifyDataAvailable() to provide the blocking operation.
sl@0: Note it is not possible to cancel a call to ReceiveBlocking().
sl@0: 
sl@0: The function is implemented through a call to 
sl@0: RMsgQueueBase::ReceiveBlocking().
sl@0: 
sl@0: @param aMessage The object into which the message is retrieved.
sl@0: 	
sl@0: @see RMsgQueueBase::ReceiveBlocking
sl@0: */
sl@0: 	{RMsgQueueBase::ReceiveBlocking(&aMessage, sizeof(T));}
sl@0: