1 kumpf 1.1 //%2006////////////////////////////////////////////////////////////////////////
  2           //
  3           // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4           // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5           // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
  6           // IBM Corp.; EMC Corporation, The Open Group.
  7           // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8           // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9           // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10           // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11           // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12           // EMC Corporation; Symantec Corporation; The Open Group.
 13           //
 14           // Permission is hereby granted, free of charge, to any person obtaining a copy
 15           // of this software and associated documentation files (the "Software"), to
 16           // deal in the Software without restriction, including without limitation the
 17           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18           // sell copies of the Software, and to permit persons to whom the Software is
 19           // furnished to do so, subject to the following conditions:
 20           // 
 21           // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22 kumpf 1.1 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29           //
 30           //==============================================================================
 31           //
 32           //%/////////////////////////////////////////////////////////////////////////////
 33           
 34           #ifndef Pegasus_ServerRunStatus_h
 35           #define Pegasus_ServerRunStatus_h
 36           

 37 dave.sudlik 1.2 #ifdef PEGASUS_OS_TYPE_WINDOWS
 38                 #include <windows.h>
 39                 #endif

 40 kumpf       1.1 #include <Pegasus/Common/Config.h>
 41                 #include <Pegasus/Common/String.h>
 42                 #include <Service/Linkage.h>
 43                 
 44                 PEGASUS_NAMESPACE_BEGIN
 45                 

 46 ouyang.jian 1.3 #if defined(PEGASUS_OS_TYPE_WINDOWS)

 47 kumpf       1.1 typedef int PEGASUS_PID_T;
 48                 #else
 49                 typedef pid_t PEGASUS_PID_T;
 50                 #endif
 51                 
 52                 /**
 53                     The ServerRunStatus class is used to manage the run status of a
 54                     server.  It can be used to determine if an instance of the server is
 55                     already running, to kill a running instance, and to indicate that an
 56                     instance is being started.
 57                 
 58                     The implementation varies per platform.  On Unix platforms, a PID file
 59                     is used to record the process ID of the running server.  On Windows,
 60                     an event handle is used and the PID parameters are not meaningful.
 61                 */
 62                 class PEGASUS_SERVICE_LINKAGE ServerRunStatus
 63                 {
 64                 public:
 65                 
 66                     /**
 67                         Constructs a ServerRunStatus instance with the specified server
 68 kumpf       1.1         parameters.
 69                     */
 70                     ServerRunStatus(
 71                         const char* serverName,
 72                         const char* pidFilePath);
 73                 
 74                     /**
 75                         Destructs the ServerRunStatus instance.  On Windows, this
 76                         indicates to the system that this instance of the server is no
 77                         longer running.
 78                     */
 79                     ~ServerRunStatus();
 80                 
 81                     /**
 82                         Determines whether the server is running, based on the parameters
 83                         specified in the constructor.
 84                     */
 85                     Boolean isServerRunning();
 86                 
 87                     /**
 88                         Indicates that this instance of the server is now running.
 89 kumpf       1.1     */
 90                     void setServerRunning();
 91                 
 92                     /**
 93                         On platforms that use a PID file, this method allows a parent process
 94                         ID to be specified.  This allows the isServerRunning() method to take
 95                         the parent process into consideration.
 96                     */
 97                     void setParentPid(PEGASUS_PID_T parentPid);
 98                 
 99                     /**
100                         Sends a SIGKILL signal to the running server process on platforms
101                         that support signals.
102                     */
103                     Boolean kill();
104                 
105                 private:
106                 
107                     /**
108                         Determines whether the specified process ID is an instance of the
109                         server specified in the constructor.
110 kumpf       1.1     */
111                     Boolean _isServerProcess(PEGASUS_PID_T pid);
112                 
113                     const char* _serverName;
114                     const char* _pidFilePath;
115                     PEGASUS_PID_T _parentPid;
116                 
117                 #ifdef PEGASUS_OS_TYPE_WINDOWS
118                     HANDLE _event;
119                     Boolean _wasAlreadyRunning;
120                 #endif
121                 };
122                 
123                 PEGASUS_NAMESPACE_END
124                 
125                 #endif // Pegasus_ServerRunStatus_h