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