﻿<?xml version="1.0" encoding="utf-8"?>
<!--DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"-->
<?xml-stylesheet href="../scheduler.xsl" type="text/xsl"?>

<!--$Id: modify_spooler.xml,v 1.5 2004/09/07 06:25:36 jz Exp $-->

<!--         title    = "Kommando an den ganzen Scheduler"-->

<xml_element name     = "modify_spooler" 
             title    = "Commands for the Job Scheduler"
             base_dir = "../"
             author   = "$Author: aa $"
             date     = "$Date: 2007-10-22 17:40:29 +0200 (Mo, 22 Okt 2007) $">



    <description>
        <p>
            The following sub-commands are not carried out after the Job Scheduler has halted because 
            of insufficient disc space for a log file
            (<scheduler_element name="state" attribute="waiting_errno" directory="xml/answer/"/>):
        <!--Wenn der Scheduler wegen Plattenplatzmangel für ein Protokoll angehalten hat
            (<code><a href="answer/state.xml#attribute_waiting_errno">&lt;state waiting_errno="..."/></a></code>),
            werden die Subkommandos -->
            <code>pause</code>, 
            <code>reload</code>, 
            <code>terminate</code>,
            <code>terminate_and_restart</code>,
            <code>let_run_terminate_and_restart</code>.
            On the other hand 
            <code>continue</code>, 
            <code>abort_immediately</code> and 
        <!--<code>abort_immediately</code> und -->
            <code>abort_immediately_and_restart</code> are immediately effective.
        <!--nicht sofort ausgeführt.
            Dagegen wirken <code>continue</code>, <code>abort_immediately</code> und <code>abort_immediately_and_restart</code> sofort.-->
        </p>
    </description>


    <xml_parent_elements>
        <xml_parent_element name="commands"/>
    </xml_parent_elements>


    <xml_attributes>
        <xml_attribute name="cmd" type="cmd">
            <description>
                <p>
                    The following subcommands are allowed:
                <!--Folgende Subkommandos sind möglich:-->
                </p>
                
                <dl>
                    <dt><code>cmd="pause"</code></dt>
                    <dd>
                        Stops the Job Scheduler temporarily (pauses).
                        Tasks running in their own processes continue, as long as they do not require to communicate with the Job Scheduler.
                    <!--Hält den Scheduler vorübergehend an.
                        Tasks in eigenen Prozessen laufen noch solange weiter, wie sie nicht mit dem Scheduler kommunizieren.-->
                    </dd>
                    
                    <dt><code>cmd="continue"</code></dt>
                    <dd>
                        Revokes <code>cmd="pause"</code>.
                    <!--Hebt <code>cmd="pause"</code> auf.-->
                        Or causes the Job Scheduler to continus,should it have stopped because of insufficient disk space for log files
                        (<scheduler_element name="state" attribute="waiting_errno" directory="xml/answer/">see here</scheduler_element>).
                    <!--Oder setzt den Scheduler fort, wenn er wegen Platzmangels für die Protokolldateien angehalten hat
                        (<scheduler_element name="state" attribute="waiting_errno" directory="xml/answer/">siehe hier</scheduler_element>).-->
                    </dd>
                    
                    <dt><code>cmd="stop"</code></dt>
                    <dd>
                        Stops the Job Scheduler without terminating the program. Any running tasks are stopped.
                        This command is useful if followed by the command <i>reload</i>.
                    </dd>
                    
                    <dt><code>cmd="reload"</code></dt>
                    <dd>
                        Reloads the job scripts.
                    <!--Lädt die Skripte der Jobs neu.-->
                    </dd>
                    
                    <dt><code>cmd="terminate"</code></dt>
                    <dd>
                        Ends the Job Scheduler regularly (see also <a href="../termination.xml">here</a>).
                    <!--Beendet den Scheduler ordentlich (näheres <a href="../termination.xml">hier</a>).-->
                    </dd>
                    
                    <dt><code>cmd="terminate_and_restart"</code></dt>
                    <dd>
                        Ends the Job Scheduler regularly and attempts a restart 
                        (see also <a href="../termination.xml">here</a>).
                        If there are any tasks running which implement the scheduler job interface, then the Job Scheduler 
                        will not execute any further calls to the <scheduler_method class="Job_impl" method="spooler_process"/> method.
                    <!--Beendet den Scheduler ordentlich und versucht ihn dann neu zu starten 
                        (näheres <a href="../termination.xml">hier</a>).-->
                    </dd>
                    
                    <dt><code>cmd="let_run_terminate_and_restart"</code></dt>
                    <dd>
                        Ends the Job Scheduler regularly and attempts a restart.
                        Tasks which are running will not be ended 
                        (other than tasks waiting with the running_waiting_for_order state).
                        See also <a href="../termination.xml">here</a>).
                    <!--Beendet den Scheduler ordentlich und versucht ihn dann neu zu starten.
                        Laufende Tasks werden nicht beendet (außer wartende Tasks im Zustand running_waiting_for_order).
                        Erst wenn sich alle Tasks beendet haben, endet der Scheduler.
                        (Näheres <a href="../termination.xml">hier</a>).-->
                    </dd>
                    
                    <dt><code>cmd="abort_immediately"</code></dt>
                    <dd>
                        The Job Scheduler is stopped immediately 
                        (see also <a href="../termination.xml">here</a>).
                    <!--Bricht den Scheduler sofort ab
                        (näheres <a href="../termination.xml">hier</a>).-->
                    </dd>
                    
                    <dt><code>cmd="abort_immediately_and_restart"</code></dt>
                    <dd>
                        The Job Scheduler is stopped immediately and a restart is attempted
                        (see also <a href="../termination.xml">here</a>).
                    <!--Bricht den Scheduler sofort ab und versucht ihn dann neu zu starten
                        (näheres <a href="../termination.xml">hier</a>).-->
                    </dd>
                    
                </dl>
            </description>
        </xml_attribute>

        <xml_attribute name="timeout" type="int">
            <description>
                <p>
                    For <code>cmd="terminate"</code> and <code>cmd="terminate_and_restart"</code>:
                    
                    the time the Job Scheduler will wait before stoping unterminated processes.
                <!--Für <code>cmd="terminate"</code> und <code>cmd="terminate_and_restart"</code>:
                    Die Frist, nach der der Scheduler nicht beendete Prozesse abbrechen soll.-->
                </p>
                <p>
                    The default setting is an unlimited waiting time.
                <!--Voreingestellt ist eine endlose Frist.-->
                </p>
                <p>
                    See <scheduler_method class="Spooler" method="terminate"/>.
                <!--Siehe <scheduler_method class="Spooler" method="terminate"/>.-->
                </p>
            </description>
        </xml_attribute>


    </xml_attributes>

    <xml_answer element="ok"/>
    
    
    <example>
        <pre>
&lt;modify_spooler cmd="abort_immediately_and_restart"/>
        </pre>
    </example>
</xml_element>

