1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/kernelhwsrv/kernel/eka/include/e32msgqueue.inl Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,173 @@
1.4 +// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// e32/include/e32msgqueue.inl
1.18 +//
1.19 +//
1.20 +
1.21 +
1.22 +
1.23 +
1.24 +template <typename T>
1.25 +inline TInt RMsgQueue<T>::CreateLocal(TInt aSize, TOwnerType aOwner)
1.26 +/**
1.27 +Creates a message queue that is private to the current process,
1.28 +and opens a handle to that message queue.
1.29 +
1.30 +The size of each message in the queue is the size of the template
1.31 +parameter type.
1.32 +This must conform to the restrictions imposed on the aMsgLength parameter
1.33 +passed to the base class function RMsgQueueBase::CreateLocal().
1.34 +
1.35 +@param aSize The number of message 'slots' in the queue.
1.36 + This must be a positive value, i.e. greater than zero.
1.37 +@param aOwner The type of handle to be created.
1.38 + EOwnerProcess is the default value, if not explicitly specified.
1.39 +
1.40 +@return KErrNone if the queue is created sucessfully, otherwise one of
1.41 + the other system wide error codes.
1.42 +
1.43 +@panic KERN-EXEC 49 if aSize is less than or equal to zero.
1.44 +@panic KERN-EXEC 48 if the size of the template parameter type is not
1.45 + a multiple of 4 bytes, is less than 4, or is greater than KMaxLength.
1.46 +
1.47 +@see RMsgQueueBase::CreateLocal
1.48 +@see KMaxLength
1.49 +*/
1.50 + {return RMsgQueueBase::CreateLocal(aSize, sizeof(T), aOwner);}
1.51 +
1.52 +
1.53 +
1.54 +
1.55 +template <typename T>
1.56 +inline TInt RMsgQueue<T>::CreateGlobal(const TDesC& aName, TInt aSize, TOwnerType aOwner)
1.57 +/**
1.58 +Creates a global message queue, and opens a handle to that
1.59 +message queue.
1.60 +
1.61 +If the name is non-empty, the message queue is visible to all processes.
1.62 +If the name is empty it cannot be opened or searched for by name, but a handle
1.63 +to it can be passed to another process as a process parameter or via IPC.
1.64 +
1.65 +The size of each message in the queue is the size of the template
1.66 +parameter type.
1.67 +This must conform to the restrictions imposed on the aMsgLength parameter
1.68 +passed to the base class function RMsgQueueBase::CreateGlobal().
1.69 +
1.70 +@param aName The name to be assigned to the message queue.
1.71 +@param aSize The number of message 'slots' in the queue.
1.72 + This must be a positive value, i.e. greater than zero.
1.73 +@param aOwner The type of handle to be created.
1.74 + EOwnerProcess is the default value, if not explicitly specified.
1.75 +
1.76 +@return KErrNone if the queue is created sucessfully, otherwise one of
1.77 + the other system wide error codes.
1.78 +
1.79 +@panic KERN-EXEC 49 if aSize is less than or equal to zero.
1.80 +@panic KERN-EXEC 48 if the size of the template parameter type is not
1.81 + a multiple of 4 bytes, is less than 4, or is greater than KMaxLength.
1.82 +
1.83 +@see RMsgQueueBase::CreateGlobal
1.84 +@see KMaxLength
1.85 +*/
1.86 + {return RMsgQueueBase::CreateGlobal(aName, aSize, sizeof(T), aOwner);}
1.87 +
1.88 +
1.89 +
1.90 +
1.91 +//realtime
1.92 +template <typename T>
1.93 +inline TInt RMsgQueue<T>::Send(const T& aMessage)
1.94 +/**
1.95 +
1.96 +Sends a message through this queue.
1.97 +
1.98 +The function does not wait (i.e. block), if the queue is full.
1.99 +
1.100 +The function is implemented through a call to
1.101 +RMsgQueueBase::Send().
1.102 +
1.103 +@param aMessage The message data to be sent.
1.104 +
1.105 +@return KErrNone, if successful;
1.106 + KErrOverflow, if queue is full,
1.107 +
1.108 +@see RMsgQueueBase::Send
1.109 +*/
1.110 + {return RMsgQueueBase::Send(&aMessage, sizeof(T));}
1.111 +
1.112 +
1.113 +
1.114 +
1.115 +template <typename T>
1.116 +inline void RMsgQueue<T>::SendBlocking(const T& aMessage)
1.117 +/**
1.118 +Sends a message through this queue, and waits for space to become available
1.119 +if the queue is full.
1.120 +
1.121 +The function uses NotifySpaceAvailable() to provide the blocking operation.
1.122 +Note that it is not possible to cancel a call to SendBlocking().
1.123 +
1.124 +The function is implemented through a call to
1.125 +RMsgQueueBase::SendBlocking().
1.126 +
1.127 +@param aMessage The message data to be sent.
1.128 +
1.129 +@see RMsgQueueBase::SendBlocking
1.130 +*/
1.131 + {RMsgQueueBase::SendBlocking(&aMessage, sizeof(T));}
1.132 +
1.133 +
1.134 +
1.135 +
1.136 +//realtime
1.137 +template <typename T>
1.138 +inline TInt RMsgQueue<T>::Receive(T& aMessage)
1.139 +/**
1.140 +
1.141 +Retrieves the first message in the queue.
1.142 +
1.143 +The function does not wait (i.e. block), if the queue is empty.
1.144 +
1.145 +The function is implemented through a call to
1.146 +RMsgQueueBase::Receive().
1.147 +
1.148 +@param aMessage The object into which the message is retrieved.
1.149 +
1.150 +@return KErrNone, ifsuccessful;
1.151 + KErrUnderflow, if the queue is empty.
1.152 +
1.153 +@see RMsgQueueBase::Receive
1.154 +*/
1.155 + {return RMsgQueueBase::Receive(&aMessage, sizeof(T));}
1.156 +
1.157 +
1.158 +
1.159 +
1.160 +template <typename T>
1.161 +inline void RMsgQueue<T>::ReceiveBlocking(T& aMessage)
1.162 +/**
1.163 +Retrieves the first message in the queue, and waits if the queue is empty.
1.164 +
1.165 +The function uses NotifyDataAvailable() to provide the blocking operation.
1.166 +Note it is not possible to cancel a call to ReceiveBlocking().
1.167 +
1.168 +The function is implemented through a call to
1.169 +RMsgQueueBase::ReceiveBlocking().
1.170 +
1.171 +@param aMessage The object into which the message is retrieved.
1.172 +
1.173 +@see RMsgQueueBase::ReceiveBlocking
1.174 +*/
1.175 + {RMsgQueueBase::ReceiveBlocking(&aMessage, sizeof(T));}
1.176 +