Process.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Quest Software, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* 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 
*       Quest Software, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees 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.
*******************************************************************************/


#ifndef BLOCXX_PROCESS_HPP_INCLUDE_GUARD_
#define BLOCXX_PROCESS_HPP_INCLUDE_GUARD_

#include "blocxx/BLOCXX_config.h"
#include "blocxx/Exception.hpp"
#include "blocxx/Types.hpp"
#include "blocxx/IntrusiveCountableBase.hpp"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/Cstr.hpp"
#include "blocxx/Timeout.hpp"
  // For Exec::spawn
#include <vector>

namespace BLOCXX_NAMESPACE
{

BLOCXX_DECLARE_EXCEPTION(ProcessError);

class ProcessImpl;
typedef IntrusiveReference<ProcessImpl> ProcessImplRef;

//
class BLOCXX_COMMON_API Process : public IntrusiveCountableBase
{
public:
   //
   Process(
      UnnamedPipeRef const & in, UnnamedPipeRef const & out,
      UnnamedPipeRef const & err, ProcId pid
   );

protected:
   //
   Process(
      const ProcessImplRef& impl, UnnamedPipeRef const & in, UnnamedPipeRef const & out,
      UnnamedPipeRef const & err, ProcId pid
   );

public:
   Process(ProcId pid);

   void release();

   virtual ~Process();

   UnnamedPipeRef in() const;

   UnnamedPipeRef out() const;

   UnnamedPipeRef err() const;

   ProcId pid() const;

   //
   class BLOCXX_COMMON_API Status
   {
   public:
      struct Repr { };


      //
      Status(ProcId wpid, int status);

      //
      Status(int rep1, int rep2, Repr);

      //
      Status();

      //
      bool running() const;

      //
      bool exitTerminated() const;

      int exitStatus() const;

      //
      bool terminatedSuccessfully() const;

      //
      bool signalTerminated() const;

      //
      bool terminated() const;
      
      //
      int termSignal() const;

      //
      bool stopped() const;

      //
      int stopSignal() const;

      String toString() const;

      int getPOSIXwaitpidStatus() const; 
   
      void repr(int & rep1, int & rep2) const;
      
   private:
      bool m_status_available;
      int m_status;
   };

   Status processStatus();

   enum ETerminationSelectionFlag
   {
      E_TERMINATE_PROCESS_GROUP,
      E_TERMINATE_PROCESS_ONLY
   };
   void waitCloseTerm(
      const Timeout& wait_initial = Timeout::relative(5.0), 
      const Timeout& wait_close =   Timeout::relative(10.0), 
      const Timeout& wait_term =    Timeout::relative(15.0),
      ETerminationSelectionFlag terminationSelectionFlag = E_TERMINATE_PROCESS_GROUP);

   void waitCloseTerm(float wait_initial, float wait_close, float wait_term);

private:
   bool terminatesWithin(const Timeout& wait_time);
   ProcId getCurProcessId();
   
#ifdef BLOCXX_WIN32
   bool terminateByMessage(const Timeout& waitTime);
   bool killProcess(const Timeout& waitTime, ETerminationSelectionFlag terminationSelectionFlag);
#else
   bool killWait(const Timeout& wait_time, int sig, char const * signame, ETerminationSelectionFlag terminationSelectionFlag);
#endif

   Process(Process const &);

   void operator=(Process const &);

   ProcessImplRef m_impl;
   UnnamedPipeRef m_in;
   UnnamedPipeRef m_out;
   UnnamedPipeRef m_err;
   ProcId m_pid;
   Status m_status;
};

class BLOCXX_COMMON_API ProcessImpl : public IntrusiveCountableBase
{
public:
   virtual ~ProcessImpl();

   virtual int kill(ProcId pid, int sig) = 0;

   virtual Process::Status pollStatus(ProcId pid) = 0;
};



} // namespace BLOCXX_NAMESPACE

#endif