/usr/include/ptlib/svcproc.h is in libpt2.4.5-dev 2.4.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | /*
* svcproc.h
*
* Service Process (daemon) class.
*
* Portable Windows Library
*
* Copyright (c) 1993-1998 Equivalence Pty. Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Portable Windows Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Portions are Copyright (C) 1993 Free Software Foundation, Inc.
* All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* $Revision: 21583 $
* $Author: rjongbloed $
* $Date: 2008-11-20 12:56:31 +0000 (Thu, 20 Nov 2008) $
*/
#ifndef _PSERVICEPROCESS
#define _PSERVICEPROCESS
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <ptlib/pprocess.h>
/** This class abstracts the operating system dependent error logging facility.
To send messages to the system error log, the PSYSTEMLOG macro should be used.
*/
class PSystemLog : public PObject, public iostream {
PCLASSINFO(PSystemLog, PObject);
public:
/**@name Construction */
//@{
/// define the different error log levels
enum Level {
/// Log from standard error stream
StdError = -1,
/// Log a fatal error
Fatal,
/// Log a non-fatal error
Error,
/// Log a warning
Warning,
/// Log general information
Info,
/// Log debugging information
Debug,
/// Log more debugging information
Debug2,
/// Log even more debugging information
Debug3,
/// Log a lot of debugging information
Debug4,
/// Log a real lot of debugging information
Debug5,
/// Log a bucket load of debugging information
Debug6,
NumLogLevels
};
/// Create a system log stream
PSystemLog(
Level level ///< only messages at this level or higher will be logged
);
/// Destroy the string stream, deleting the stream buffer
~PSystemLog() { flush(); }
//@}
/**@name Output functions */
//@{
/** Log an error into the system log.
*/
static void Output(
Level level, ///< Log level for this log message.
const char * msg ///< Message to be logged
);
//@}
/**@name Miscellaneous functions */
//@{
/** Set the level at which errors are logged. Only messages higher than or
equal to the specified level will be logged.
*/
void SetLevel(
Level level ///< New log level
) { logLevel = level; }
/** Get the current level for logging.
@return
Log level.
*/
Level GetLevel() const { return logLevel; }
//@}
private:
PSystemLog(const PSystemLog & other);
PSystemLog & operator=(const PSystemLog &);
class Buffer : public streambuf {
public:
virtual int_type overflow(int=EOF);
virtual int_type underflow();
virtual int sync();
PSystemLog * log;
PString string;
} buffer;
friend class Buffer;
Level logLevel;
};
/** Log a message to the system log.
The current log level is checked and if allowed, the second argument is evaluated
as a stream output sequence which is them output to the system log.
*/
#define PSYSTEMLOG(level, variables) \
if (PServiceProcess::Current().GetLogLevel() >= PSystemLog::level) { \
PSystemLog P_systemlog(PSystemLog::level); \
P_systemlog << variables; \
} else (void)0
/** A process type that runs as a "background" service.
This may be a service under the Windows NT operating system, or a "daemon" under Unix, or a hidden application under Windows.
*/
class PServiceProcess : public PProcess
{
PCLASSINFO(PServiceProcess, PProcess);
public:
/**@name Construction */
//@{
/** Create a new service process.
*/
PServiceProcess(
const char * manuf, ///< Name of manufacturer
const char * name, ///< Name of product
WORD majorVersion, ///< Major version number of the product
WORD minorVersion, ///< Minor version number of the product
CodeStatus status, ///< Development status of the product
WORD buildNumber ///< Build number of the product
);
//@}
/**@name Callback functions */
//@{
/** Called when the service is started. This typically initialises the
service and returns PTrue if the service is ready to run. The
#Main()# function is then executed.
@return
PTrue if service may start, PFalse if an initialisation failure occurred.
*/
virtual PBoolean OnStart() = 0;
/** Called by the system when the service is stopped. One return from this
function there is no guarentee that any more user code will be executed.
Any cleaning up or closing of resource must be done in here.
*/
virtual void OnStop();
/** Called by the system when the service is to be paused. This will
suspend any actions that the service may be executing. Usually this is
less expensive in resource allocation etc than stopping and starting
the service.
@return
PTrue if the service was successfully paused.
*/
virtual PBoolean OnPause();
/** Resume after the service was paused.
*/
virtual void OnContinue();
/** The Control menu option was used in the SysTray menu.
*/
virtual void OnControl() = 0;
//@}
/**@name Miscellaneous functions */
//@{
/** Get the current service process object.
@return
Pointer to service process.
*/
static PServiceProcess & Current();
/** Set the level at which errors are logged. Only messages higher than or
equal to the specified level will be logged.
The default is #LogError# allowing fatal errors and ordinary\
errors to be logged and warning and information to be ignored.
If in debug mode then the default is #LogInfo# allowing all
messages to be displayed.
*/
void SetLogLevel(
PSystemLog::Level level ///< New log level
) { currentLogLevel = level; }
/** Get the current level for logging.
@return
Log level.
*/
PSystemLog::Level GetLogLevel() const { return currentLogLevel; }
//@}
/* Internal initialisation function called directly from
#main()#. The user should never call this function.
*/
virtual int _main(void * arg = NULL);
protected:
// Member variables
/// Flag to indicate service is run in simulation mode.
PBoolean debugMode;
/// Current log level for #PSYSTEMLOG# calls.
PSystemLog::Level currentLogLevel;
friend void PSystemLog::Output(PSystemLog::Level, const char *);
// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/svcproc.h"
#else
#include "unix/ptlib/svcproc.h"
#endif
};
#endif
// End Of File ///////////////////////////////////////////////////////////////
|