1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of the License "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // e32/include/e32msgqueue.inl
22 inline TInt RMsgQueue<T>::CreateLocal(TInt aSize, TOwnerType aOwner)
24 Creates a message queue that is private to the current process,
25 and opens a handle to that message queue.
27 The size of each message in the queue is the size of the template
29 This must conform to the restrictions imposed on the aMsgLength parameter
30 passed to the base class function RMsgQueueBase::CreateLocal().
32 @param aSize The number of message 'slots' in the queue.
33 This must be a positive value, i.e. greater than zero.
34 @param aOwner The type of handle to be created.
35 EOwnerProcess is the default value, if not explicitly specified.
37 @return KErrNone if the queue is created sucessfully, otherwise one of
38 the other system wide error codes.
40 @panic KERN-EXEC 49 if aSize is less than or equal to zero.
41 @panic KERN-EXEC 48 if the size of the template parameter type is not
42 a multiple of 4 bytes, is less than 4, or is greater than KMaxLength.
44 @see RMsgQueueBase::CreateLocal
47 {return RMsgQueueBase::CreateLocal(aSize, sizeof(T), aOwner);}
53 inline TInt RMsgQueue<T>::CreateGlobal(const TDesC& aName, TInt aSize, TOwnerType aOwner)
55 Creates a global message queue, and opens a handle to that
58 If the name is non-empty, the message queue is visible to all processes.
59 If the name is empty it cannot be opened or searched for by name, but a handle
60 to it can be passed to another process as a process parameter or via IPC.
62 The size of each message in the queue is the size of the template
64 This must conform to the restrictions imposed on the aMsgLength parameter
65 passed to the base class function RMsgQueueBase::CreateGlobal().
67 @param aName The name to be assigned to the message queue.
68 @param aSize The number of message 'slots' in the queue.
69 This must be a positive value, i.e. greater than zero.
70 @param aOwner The type of handle to be created.
71 EOwnerProcess is the default value, if not explicitly specified.
73 @return KErrNone if the queue is created sucessfully, otherwise one of
74 the other system wide error codes.
76 @panic KERN-EXEC 49 if aSize is less than or equal to zero.
77 @panic KERN-EXEC 48 if the size of the template parameter type is not
78 a multiple of 4 bytes, is less than 4, or is greater than KMaxLength.
80 @see RMsgQueueBase::CreateGlobal
83 {return RMsgQueueBase::CreateGlobal(aName, aSize, sizeof(T), aOwner);}
90 inline TInt RMsgQueue<T>::Send(const T& aMessage)
93 Sends a message through this queue.
95 The function does not wait (i.e. block), if the queue is full.
97 The function is implemented through a call to
98 RMsgQueueBase::Send().
100 @param aMessage The message data to be sent.
102 @return KErrNone, if successful;
103 KErrOverflow, if queue is full,
105 @see RMsgQueueBase::Send
107 {return RMsgQueueBase::Send(&aMessage, sizeof(T));}
112 template <typename T>
113 inline void RMsgQueue<T>::SendBlocking(const T& aMessage)
115 Sends a message through this queue, and waits for space to become available
116 if the queue is full.
118 The function uses NotifySpaceAvailable() to provide the blocking operation.
119 Note that it is not possible to cancel a call to SendBlocking().
121 The function is implemented through a call to
122 RMsgQueueBase::SendBlocking().
124 @param aMessage The message data to be sent.
126 @see RMsgQueueBase::SendBlocking
128 {RMsgQueueBase::SendBlocking(&aMessage, sizeof(T));}
134 template <typename T>
135 inline TInt RMsgQueue<T>::Receive(T& aMessage)
138 Retrieves the first message in the queue.
140 The function does not wait (i.e. block), if the queue is empty.
142 The function is implemented through a call to
143 RMsgQueueBase::Receive().
145 @param aMessage The object into which the message is retrieved.
147 @return KErrNone, ifsuccessful;
148 KErrUnderflow, if the queue is empty.
150 @see RMsgQueueBase::Receive
152 {return RMsgQueueBase::Receive(&aMessage, sizeof(T));}
157 template <typename T>
158 inline void RMsgQueue<T>::ReceiveBlocking(T& aMessage)
160 Retrieves the first message in the queue, and waits if the queue is empty.
162 The function uses NotifyDataAvailable() to provide the blocking operation.
163 Note it is not possible to cancel a call to ReceiveBlocking().
165 The function is implemented through a call to
166 RMsgQueueBase::ReceiveBlocking().
168 @param aMessage The object into which the message is retrieved.
170 @see RMsgQueueBase::ReceiveBlocking
172 {RMsgQueueBase::ReceiveBlocking(&aMessage, sizeof(T));}