|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
/**
|
|
sl@0
|
20 |
@file
|
|
sl@0
|
21 |
@publishedAll
|
|
sl@0
|
22 |
@released
|
|
sl@0
|
23 |
*/
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#ifndef __MCTTOKENINTERFACE_H__
|
|
sl@0
|
26 |
#define __MCTTOKENINTERFACE_H__
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
class MCTToken;
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
/**
|
|
sl@0
|
31 |
* The base class for all token interfaces.
|
|
sl@0
|
32 |
*
|
|
sl@0
|
33 |
* This class provides functionality to interact with the token's reference counting
|
|
sl@0
|
34 |
* framework. (Interfaces themselves are not reference counted, but the token
|
|
sl@0
|
35 |
* must remain open while it has open interfaces.)
|
|
sl@0
|
36 |
*
|
|
sl@0
|
37 |
* @since v7.0
|
|
sl@0
|
38 |
*/
|
|
sl@0
|
39 |
class MCTTokenInterface
|
|
sl@0
|
40 |
{
|
|
sl@0
|
41 |
public:
|
|
sl@0
|
42 |
/**
|
|
sl@0
|
43 |
* Gets the associated token.
|
|
sl@0
|
44 |
*
|
|
sl@0
|
45 |
* @return The associated token.
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
virtual MCTToken& Token() = 0;
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
/**
|
|
sl@0
|
50 |
* Destroys the object.
|
|
sl@0
|
51 |
*
|
|
sl@0
|
52 |
* The interface should be destroyed via this method as the destructor is protected.
|
|
sl@0
|
53 |
*
|
|
sl@0
|
54 |
* Also takes care of reference counting the token.
|
|
sl@0
|
55 |
*/
|
|
sl@0
|
56 |
IMPORT_C void Release();
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
protected:
|
|
sl@0
|
59 |
/**
|
|
sl@0
|
60 |
* This function should release the interface and all its owned resources.
|
|
sl@0
|
61 |
*
|
|
sl@0
|
62 |
* It is called by Release(). The default implementation simply does a 'delete
|
|
sl@0
|
63 |
* this'. If other behaviour is required (for instance to implement a reference
|
|
sl@0
|
64 |
* counting system for the interfaces themselves, the interfaces can override
|
|
sl@0
|
65 |
* this function.)
|
|
sl@0
|
66 |
*/
|
|
sl@0
|
67 |
IMPORT_C virtual void DoRelease();
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
/**
|
|
sl@0
|
70 |
* The interface should be destroyed via the Release()
|
|
sl@0
|
71 |
* function. Hence, this destructor is protected.
|
|
sl@0
|
72 |
*/
|
|
sl@0
|
73 |
inline virtual ~MCTTokenInterface() = 0;
|
|
sl@0
|
74 |
};
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
/** Destructor */
|
|
sl@0
|
77 |
inline MCTTokenInterface::~MCTTokenInterface()
|
|
sl@0
|
78 |
{
|
|
sl@0
|
79 |
}
|
|
sl@0
|
80 |
|
|
sl@0
|
81 |
#endif // __MCTTOKENINTERFACE_H__
|