Module: Process

Extended by:: FFI::Library, Puppet::FFI::Windows::APITypes, Puppet::FFI::Windows::Functions, Puppet::FFI::Windows::Structs, Puppet::Util::Windows::String

Includes:: Puppet::FFI::Windows::Constants, Puppet::FFI::Windows::Structs

Defined in:: lib/puppet/util/windows/monkey_patches/process.rb

Constant Summary

Constants included from Puppet::FFI::Windows::Functions

Puppet::FFI::Windows::Functions::SC_ENUM_TYPE, Puppet::FFI::Windows::Functions::SC_STATUS_TYPE

Constants included from Puppet::FFI::Windows::Constants

Constants included from Puppet::FFI::Windows::Structs

Puppet::FFI::Windows::Structs::MAXIMUM_REPARSE_DATA_BUFFER_SIZE

Class Method Summary collapse

.create(args) ⇒ Object
.setpriority(kind, int, int_priority) ⇒ Object

Sets the priority class for the specified process id int.

Methods included from FFI::Library

attach_function_private

Methods included from Puppet::Util::Windows::String

wide_string

Class Method Details

.create(args) ⇒ `Object`

# File 'lib/puppet/util/windows/monkey_patches/process.rb', line 120

def create(args)
  # Validate that args is a Hash
  validate_args(args)

  initialize_defaults

  # Validate the keys, and convert symbols and case to lowercase strings.
  validate_keys(args)

  # If the startup_info key is present, validate its subkeys
  validate_startup_info if hash[:startup_info]

  # validates that 'app_name' or 'command_line' is set
  validate_command_line

  if hash[:app_name] && !hash[:command_line]
    hash[:command_line] = hash[:app_name]
    hash[:app_name] = nil
  end

  # Setup stdin, stdout and stderr handlers
  setup_std_handlers

  if logon
    create_process_with_logon
  else
    create_process
  end

  # Automatically close the process and thread handles in the
  # PROCESS_INFORMATION struct unless explicitly told not to.
  if hash[:close_handles]
    FFI::WIN32.CloseHandle(procinfo[:hProcess])
    FFI::WIN32.CloseHandle(procinfo[:hThread])
  end

  ProcessInfo.new(
    procinfo[:hProcess],
    procinfo[:hThread],
    procinfo[:dwProcessId],
    procinfo[:dwThreadId]
  )
end

.setpriority(kind, int, int_priority) ⇒ `Object`

Sets the priority class for the specified process id int.

The kind parameter is ignored but present for API compatibility. You can only retrieve process information, not process group or user information, so it is effectively always Process::PRIO_PROCESS.

Possible int_priority values are:

Process::NORMAL_PRIORITY_CLASS
Process::IDLE_PRIORITY_CLASS
Process::HIGH_PRIORITY_CLASS
Process::REALTIME_PRIORITY_CLASS
Process::BELOW_NORMAL_PRIORITY_CLASS
Process::ABOVE_NORMAL_PRIORITY_CLASS

Raises:

(TypeError)

# File 'lib/puppet/util/windows/monkey_patches/process.rb', line 181

def setpriority(kind, int, int_priority)
  raise TypeError unless kind.is_a?(Integer)
  raise TypeError unless int.is_a?(Integer)
  raise TypeError unless int_priority.is_a?(Integer)

  int = Process.pid if int == 0
  handle = OpenProcess(PROCESS_SET_INFORMATION, 0, int)

  if handle == 0
    raise SystemCallError, FFI.errno, "OpenProcess"
  end

  begin
    result = SetPriorityClass(handle, int_priority)
    raise SystemCallError, FFI.errno, "SetPriorityClass" unless result
  ensure
    FFI::WIN32.CloseHandle(handle)
  end

  0
end