summaryrefslogtreecommitdiffstats
path: root/src/serviceframework/qservice.qdoc
blob: 8f7dcd3744416a238695a9563841327f600c273f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \namespace QService
    \ingroup servicefw
    \inmodule QtServiceFramework

    \brief The QService namespace contains miscellaneous identifiers used throughout the
    Qt Service framework library.
*/

/*!
    \enum QService::Scope
    Defines the scope to be used when accessing services. Note that Symbian
    does not distinguish scopes and therefore UserScope and SystemScope may
    be used interchangeably.

    \value UserScope When adding and removing services, uses a storage location
    specific to the current user.
    When searching for services and interface implementations, first searches in the
    user-specific location; if the service or interface implementation
    is not found, searches in the system-wide storage location (if the user has
    sufficient permissions to do so).

    \value SystemScope When adding and removing services, use a system-wide
    storage location accessible to all users. When searching
    for services and interface implementations, search only in the system-wide
    storage location.
*/

/*!
    \enum QService::UnrecoverableIPCError
    Defines the unrecoverable IPC error of the service 

    \value    ErrorUnknown                  An unknown IPC error.
    \value    ErrorServiceNoLongerAvailable Indicates that the service is no longer available.
    \value    ErrorOutofMemory              Indicates that the service is out of memoruy.
    \value    ErrorPermissionDenied         Indicates that the permission of this service is denied.
    \value    ErrorInvalidArguments         User uses invalid argument for this service.
*/

/*!
    \enum QService::Type
    Defines the type of the service 

    \value    Plugin          This denotes that the service is plug-in based.
    \value    InterProcess    This denotes that the service is deployed using IPC mechanisms 
                              available on the current platform, such as DBus or local sockets.
*/