summaryrefslogtreecommitdiffstats
path: root/qtservice/examples/controller/controller.qdoc
blob: 3d6b08a2ccdcd9cb5fcf71ebda308ef64dc3122a (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
75
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
**     of its contributors may be used to endorse or promote products derived
**     from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*! \page qtservice-example-controller.html
    \title A simple Service Controller

    It is a very simple implementation of universal command-line
    controller.  This controller can install and control any service
    written using QtService component.  It demonstrates how to use
    QtServiceController class. On Windows, this is an alternative to
    using the "Services" Administrative Tool or the built-in \c sc.exe
    command-line tool to control services.

    A note about services on Windows Vista: Installing/uninstalling
    and starting/stopping services requires security privileges. The
    simplest way to achieve this is to set the "Run as Administrator"
    property on the executable (right-click the executable file,
    select Properties, and choose the Compatibilty tab in the
    Properties dialog). This applies even if you are logged in as
    Administrator. Also, the command-line shell should be started with
    "Run as Administrator". Note that the service itself does not need
    special privileges to run. Only if you want the service to be able
    to install itself (the -i option) or similar, then the service
    will need to be run as Administrator. Otherwise, the recommended
    procedure is to use a controller such as this example and/or the
    "Services" Administrative Tool to manage the service.

    A usability hint: in some circumstances, e.g. when running this
    example on Windows Vista with the "Run as Administrator" property
    set, output will be sent to a shell window which will close
    immediately upon termination, not leaving the user enough time to
    read the output. In such cases, append the -w(ait) argument, which
    will make the controller wait for a keypress before terminating.

    Here is the complete source code:

    \quotefile controller/main.cpp
*/