help/info/kill.html

   1 <!--
   2  Copyright (c) 2000-2016 Ericsson Telecom AB
   3  All rights reserved. This program and the accompanying materials
   4  are made available under the terms of the Eclipse Public License v1.0
   5  which accompanies this distribution, and is available at
   6  http://www.eclipse.org/legal/epl-v10.html
   7
   8  Contributors:
   9   Baji, Laszlo
  10   Balasko, Jeno
  11   Forstner, Matyas
  12   Gecse, Roland
  13   Szabados, Kristof
  14 -->
  15 <html>
  16 <head>
  17 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  18 <meta http-equiv="Content-Language" content="en-us">
  19 <title>kill</title>
  20 </head>
  21 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  22 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  23   <tr>
  24     <td width=105 height=40><a href="https://projects.eclipse.org/projects/tools.titan"><img src="../images/titan_transparent.gif" border=0 width=105 height=40 align="left" alt="Titan"></a></td>
  25   </tr>
  26 </table>
  27 <table border="0" align="right" cellpadding="0" cellspacing="0">
  28   <tr>
  29     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  30     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  31     <td><a href="ispresent.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  32     <td><a href="killed.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  33   </tr>
  34 </table>
  35 <p><br clear="all">
  36 </p>
  37 <hr>
  38 <h1>kill</h1>
  39 <p>The kill operation results in annihilation of a component. It operates similarly to the stop operation but even the alive components are unable to execute functions any more after they were
  40 killed.
  41 <ul>
  42   <li>When used in a test case, altstep or function that are executed on a test component, the keyword terminates the relevant test component;</li>
  43   <li>When prefixed with a component reference, than the addressed remote component will be killed;</li>
  44   <li>When prefixed with the <a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a> <a href="component.html"> <b><font
  45     face="Courier New" color="#003258" size="4">component</font></b> </a> keyword pair, all components except the main test component will be killed.</li>
  46 </ul>
  47 <p>Related keywords:</p>
  48 <ul>
  49   <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li>
  50   <li><a href="component.html"> <b><font face="Courier New" color="#003258" size="4">component</font></b> </a></li>
  51   <li><a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a></li>
  52 </ul>
  53 <hr align="left" width="50%">
  54 <div align="center">
  55 <center>
  56 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  57   <tr>
  58     <td width="100%">
  59     <h3 align="center">[ <i>component_reference</i><font face="Courier New" color="#003258" size="5"><b>.</b></font>] <font face="Courier New" color="#003258" size="5"><b>kill;</b></font> &nbsp;
  60     </h3>
  61     </td>
  62   </tr>
  63 </table>
  64 </center>
  65 </div>
  66 <ul>
  67   <li>
  68   <p>The optional <i>component_reference</i> (used when other than the own component should be killed) is one of the following:</p>
  69   <ul>
  70     <li>a reference returned by the <a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a> operation to refer to a given component,</li>
  71     <li>the keyword pair <a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a> <a href="component.html"> <b><font
  72       face="Courier New" color="#003258" size="4">component</font></b> </a> when referring to all parallel test components (the command must be issued in the main test component),</li>
  73     <li>the keyword <a href="self.html"><b><font face="Courier New" color="#003258" size="4">self</font></b></a> when referring to the own component,</li>
  74     <li>the keyword <a href="mtc.html"><b><font face="Courier New" color="#003258" size="4">mtc</font></b></a> when referring to the main test component.<br>
  75     &nbsp;</li>
  76   </ul>
  77   </li>
  78   <li>
  79   <p>The <b><font face="Courier New" color="#003258" size="4">kill</font> </b> keyword denotes that (a) component(s) should be killed.</p>
  80   </li>
  81 </ul>
  82 <hr align="left" width="50%">
  83 <p>Examples:</p>
  84 <hr align="left" width="50%">
  85 <p>Example 1a:
  86 <p><code>self.kill;</code>
  87 <p>The own test component is terminated.
  88 <hr align="left" width="50%">
  89 <p>Example 1b:
  90 <p><code>vc_Hivatkozaas.kill;</code>
  91 <p>The component with the reference vc_Hivatkozaas is killed.</p>
  92 <hr align="left" width="50%">
  93 <p>Example 1c:
  94 <p><code>all component.kill;</code>
  95 <p>All parallel test components are killed.</p>
  96 <hr align="left" width="50%">
  97 <p>Example 1d:
  98 <p><code>self.kill;</code>
  99 <p>The own test component is killed.
 100 <hr align="left" width="50%">
 101 <p><a HREF="BNF.html#killoperation">BNF definition</a> of <font face="Courier New">component kill</font>
 102 </body>
 103 </html>