/vp_plugins/qtservice-2.6_1-opensource/examples/controller/controller.qdoc

 1/****************************************************************************
 2** 
 3** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
 4** All rights reserved.
 5** Contact: Nokia Corporation (qt-info@nokia.com)
 6** 
 7** This file is part of a Qt Solutions component.
 8**
 9** Commercial Usage  
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Solutions Commercial License Agreement provided
12** with the Software or, alternatively, in accordance with the terms
13** contained in a written agreement between you and Nokia.
14** 
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file.  Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22** 
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.1, included in the file LGPL_EXCEPTION.txt in this
26** package.
27** 
28** GNU General Public License Usage 
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file.  Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35** 
36** Please note Third Party Software included with Qt Solutions may impose
37** additional restrictions and it is the user's responsibility to ensure
38** that they have met the licensing requirements of the GPL, LGPL, or Qt
39** Solutions Commercial license and the relevant license of the Third
40** Party Software they are using.
41** 
42** If you are unsure which license is appropriate for your use, please
43** contact Nokia at qt-info@nokia.com.
44** 
45****************************************************************************/
46
47/*! \page qtservice-example-controller.html
48    \title A simple Service Controller
49
50    It is a very simple implementation of universal command-line
51    controller.  This controller can install and control any service
52    written using QtService component.  It demonstrates how to use
53    QtServiceController class. On Windows, this is an alternative to
54    using the "Services" Administrative Tool or the built-in \c sc.exe
55    command-line tool to control services.
56
57    A note about services on Windows Vista: Installing/uninstalling
58    and starting/stopping services requires security privileges. The
59    simplest way to achieve this is to set the "Run as Administrator"
60    property on the executable (right-click the executable file,
61    select Properties, and choose the Compatibilty tab in the
62    Properties dialog). This applies even if you are logged in as
63    Administrator. Also, the command-line shell should be started with
64    "Run as Administrator". Note that the service itself does not need
65    special privileges to run. Only if you want the service to be able
66    to install itself (the -i option) or similar, then the service
67    will need to be run as Administrator. Otherwise, the recommended
68    procedure is to use a controller such as this example and/or the
69    "Services" Administrative Tool to manage the service.
70
71    A usability hint: in some circumstances, e.g. when running this
72    example on Windows Vista with the "Run as Administrator" property
73    set, output will be sent to a shell window which will close
74    immediately upon termination, not leaving the user enough time to
75    read the output. In such cases, append the -w(ait) argument, which
76    will make the controller wait for a keypress before terminating.
77
78    Here is the complete source code:
79
80    \quotefile controller/main.cpp
81*/