### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »

# parallel.engine.kernelstarter

## Module: `parallel.engine.kernelstarter`

Inheritance diagram for `IPython.parallel.engine.kernelstarter`:

KernelStarter class that intercepts Control Queue messages, and handles process management.

Authors:

- Min RK

## `KernelStarter`

class `IPython.parallel.engine.kernelstarter.``KernelStarter`(session, upstream, downstream, *kernel_args, **kernel_kwargs)

  Bases: `object`

  Object for resetting/killing the Kernel.

  `__init__`(session, upstream, downstream, *kernel_args, **kernel_kwargs)
  `dispatch_reply`(raw_msg)
  `dispatch_request`(raw_msg)
  `has_kernel`

    Returns whether a kernel process has been specified for the kernel manager.

  `interrupt_kernel`()

    Interrupts the kernel. Unlike `signal_kernel`, this operation is well supported on all platforms.

  `is_alive`

    Is the kernel process still running?

  `kill_kernel`()

    Kill the running kernel.

  `restart_kernel`(now=False)

    Restarts a kernel with the same arguments that were used to launch it. If the old kernel was launched with random ports, the same ports will be used for the new kernel.

    Parameters :

    now : bool, optional

    > If True, the kernel is forcefully restarted immediately, without having a chance to do any cleanup action. Otherwise the kernel is given 1s to clean up before a forceful restart is issued.

    > In all cases the kernel is restarted, the only difference is whether it is given a chance to perform a clean shutdown or not.

  `shutdown_kernel`(restart=False)

    Attempts to the stop the kernel process cleanly. If the kernel cannot be stopped, it is killed, if possible.

  `shutdown_request`(msg)
  `signal_kernel`(signum)

    Sends a signal to the kernel. Note that since only SIGTERM is supported on Windows, this function is only useful on Unix systems.

  `start`()
  `start_kernel`(**kw)

    Starts a kernel process and configures the manager to use it.

    If random ports (port=0) are being used, this method must be called before the channels are created.

`IPython.parallel.engine.kernelstarter.``make_starter`(up_addr, down_addr, *args, **kwargs)

  entry point function for launching a kernelstarter in a subprocess

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »