.. _signal:


Send a signal
=============

This command allows you to send the signal to all processes in a
watcher, a specific process in a watcher or its children

ZMQ Message
-----------


To get the list of all process in the watcher::

    {
        "command": "signal",
        "property": {
            "name": <name>,
            "signum": <signum>
    }

To send a signal to a process::

    {
        "command": "signal",
        "property": {
            "name": <name>,
            "process": <processid>,
            "signum": <signum>
    }

An optionnal property "children" can be used to send the signal
to all the children rather than the process itself.

To send a signal to a process child:

To get the list of processes in a watcher::

    {
        "command": "signal",
        "property": {
            "name": <name>,
            "process": <processid>,
            "signum": <signum>,
            "pid": <pid>
    }


The response return the status "ok".

Command line
------------

::

    $ circusctl signal <name> [<process>] [<pid>] [--children] <signum>

Options:
++++++++

- <name>: the name of the watcher
- <process>: the process id. You can get them using the command list
- <pid>: integer, the process id.
- <signum> : the signal number to send.

Allowed signals are:

    - 3:    QUIT
    - 15:   TERM
    - 9:    KILL
    - 1:    HUP
    - 21:   TTIN
    - 22:   TTOU
    - 30:   USR1
    - 31:   USR2