kicad/thirdparty/sentry-native/external/crashpad/util/win/scoped_process_suspend.h

// Copyright 2015 The Crashpad Authors
//
// Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef CRASHPAD_UTIL_WIN_SCOPED_PROCESS_SUSPEND_H_
#define CRASHPAD_UTIL_WIN_SCOPED_PROCESS_SUSPEND_H_

#include <windows.h>


namespace crashpad {

//! \brief Manages the suspension of another process.
//!
//! While an object of this class exists, the other process will be suspended.
//! Once the object is destroyed, the other process will become eligible for
//! resumption.
//!
//! If this process crashes while this object exists, there is no guarantee that
//! the other process will be resumed.
class ScopedProcessSuspend {
 public:
  //! Does not take ownership of \a process.
  explicit ScopedProcessSuspend(HANDLE process);

  ScopedProcessSuspend(const ScopedProcessSuspend&) = delete;
  ScopedProcessSuspend& operator=(const ScopedProcessSuspend&) = delete;

  ~ScopedProcessSuspend();

  //! \brief Informs the object that the suspended process may be terminating,
  //!     and that this should not be treated as an error.
  //!
  //! Normally, attempting to resume a terminating process during destruction
  //! results in an error message being logged for
  //! `STATUS_PROCESS_IS_TERMINATING`. When it is known that a process may be
  //! terminating, this method may be called to suppress that error message.
  void TolerateTermination();

 private:
  HANDLE process_;
  bool tolerate_termination_ = false;
};

}  // namespace crashpad

#endif  // CRASHPAD_UTIL_WIN_SCOPED_PROCESS_SUSPEND_H_