|
sl@0
|
1 |
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of the License "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// e32\include\e32msgqueue.h
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
#ifndef __E32MSGQUEUE_H__
|
|
sl@0
|
19 |
#define __E32MSGQUEUE_H__
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
#include <e32std.h>
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
class RMsgQueueBase : public RHandleBase
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
@publishedAll
|
|
sl@0
|
29 |
@released
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
Provides implementation for managing an asynchronous message queue,
|
|
sl@0
|
32 |
and is a base class for the RMsgQueue templated class.
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
@see RMsgQueue
|
|
sl@0
|
35 |
*/
|
|
sl@0
|
36 |
{
|
|
sl@0
|
37 |
public:
|
|
sl@0
|
38 |
/**
|
|
sl@0
|
39 |
The limit for the size of an individual message.
|
|
sl@0
|
40 |
*/
|
|
sl@0
|
41 |
enum {KMaxLength = 256};
|
|
sl@0
|
42 |
|
|
sl@0
|
43 |
public:
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
IMPORT_C TInt CreateLocal(TInt aSize, TInt aMsgLength, TOwnerType aType=EOwnerProcess);
|
|
sl@0
|
46 |
IMPORT_C TInt CreateGlobal(const TDesC& aName, TInt aSize, TInt aMsgLength, TOwnerType aType=EOwnerProcess);
|
|
sl@0
|
47 |
IMPORT_C TInt OpenGlobal(const TDesC& aName, TOwnerType aType=EOwnerProcess);
|
|
sl@0
|
48 |
IMPORT_C TInt Open(RMessagePtr2 aMessage, TInt aParam, TOwnerType aType=EOwnerProcess);
|
|
sl@0
|
49 |
IMPORT_C TInt Open(TInt aArgumentIndex, TOwnerType aType=EOwnerProcess);
|
|
sl@0
|
50 |
IMPORT_C TInt Send(const TAny* aPtr, TInt aLength);
|
|
sl@0
|
51 |
IMPORT_C void SendBlocking(const TAny* aPtr, TInt aLength);
|
|
sl@0
|
52 |
IMPORT_C TInt Receive(TAny* aPtr, TInt aLength);
|
|
sl@0
|
53 |
IMPORT_C void ReceiveBlocking(TAny* aPtr, TInt aLength);
|
|
sl@0
|
54 |
IMPORT_C void NotifySpaceAvailable(TRequestStatus& aStatus);
|
|
sl@0
|
55 |
IMPORT_C void CancelSpaceAvailable();
|
|
sl@0
|
56 |
IMPORT_C void NotifyDataAvailable(TRequestStatus& aStatus);
|
|
sl@0
|
57 |
IMPORT_C void CancelDataAvailable();
|
|
sl@0
|
58 |
IMPORT_C TInt MessageSize();
|
|
sl@0
|
59 |
};
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
|
|
sl@0
|
64 |
/**
|
|
sl@0
|
65 |
@publishedAll
|
|
sl@0
|
66 |
@released
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
A handle to a message queue.
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
The templated class provides the behaviour for managing an
|
|
sl@0
|
71 |
asynchronous queue of messages, where the template parameter defines the
|
|
sl@0
|
72 |
message type.
|
|
sl@0
|
73 |
|
|
sl@0
|
74 |
The class adds a type-checking interface to the basic message queue
|
|
sl@0
|
75 |
functionality provided by RMsgQueueBase.
|
|
sl@0
|
76 |
*/
|
|
sl@0
|
77 |
template <typename T>
|
|
sl@0
|
78 |
class RMsgQueue : public RMsgQueueBase
|
|
sl@0
|
79 |
{
|
|
sl@0
|
80 |
public:
|
|
sl@0
|
81 |
TInt CreateLocal(TInt aSize, TOwnerType aType=EOwnerProcess);
|
|
sl@0
|
82 |
TInt CreateGlobal(const TDesC& aName, TInt aSize, TOwnerType aType=EOwnerProcess);
|
|
sl@0
|
83 |
TInt Send(const T& aMsg);
|
|
sl@0
|
84 |
void SendBlocking(const T& aMsg);
|
|
sl@0
|
85 |
TInt Receive(T& aMsg);
|
|
sl@0
|
86 |
void ReceiveBlocking(T& aMsg);
|
|
sl@0
|
87 |
};
|
|
sl@0
|
88 |
|
|
sl@0
|
89 |
#include <e32msgqueue.inl>
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
#endif
|