help/info/clear.html

   1 <!--
   2  Copyright (c) 2000-2014 Ericsson Telecom AB
   3
   4  All rights reserved. This program and the accompanying materials
   5  are made available under the terms of the Eclipse Public License v1.0
   6  which accompanies this distribution, and is available at
   7  http://www.eclipse.org/legal/epl-v10.html
   8  -->
   9 <html>
  10 <head>
  11 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  12 <meta http-equiv="Content-Language" content="en-us">
  13 <title>clear</title>
  14 </head>
  15 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  16 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  17   <tr>
  18     <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>
  19   </tr>
  20 </table>
  21 <table border="0" align="right" cellpadding="0" cellspacing="0">
  22   <tr>
  23     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  24     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  25     <td><a href="check.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a href="complement.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  27   </tr>
  28 </table>
  29 <p><br clear="all">
  30 </p>
  31 <hr>
  32 <h1>clear</h1>
  33 <hr align="left" width="75%">
  34 <p>The keyword is used to remove the contents of the incoming queue of the specified communication port.
  35 <ul>
  36   <li>The operation is valid for both message and procedure based ports.</li>
  37   <li>It is possible to clear all defined ports.</li>
  38   <li>If the port queue is already empty then this operation has no action.</li>
  39 </ul>
  40 <p>Related keywords:</p>
  41 <ul>
  42   <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li>
  43   <li><a href="port.html"><b><font face="Courier New" color="#003258" size="4">port</font></b></a></li>
  44 </ul>
  45 <hr align="left" width="50%">
  46 <div align="center">
  47 <center>
  48 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  49   <tr>
  50     <td width="100%">
  51     <h3 align="center"><i>port_reference</i><font face="Courier New" color="#003258" size="5"><b>.clear;</b></font></h3>
  52     </td>
  53   </tr>
  54 </table>
  55 </center>
  56 </div>
  57 <ul>
  58   <li>
  59   <p><i> port_reference</i> points out the port to be cleared.</p>
  60   <ul>
  61     <li>
  62     <p>the keywords <b><font face="Courier New" color="#003258" size="4">all port</font> </b> may be used to indicate that all defined ports must be cleared (see the <a href="#Example 2">example
  63     2</a>).</p>
  64     </li>
  65   </ul>
  66   </li>
  67   <li>
  68   <p>The <b><font face="Courier New" color="#003258" size="4">clear</font> </b> keyword introduces port cleansing.</p>
  69   </li>
  70 </ul>
  71 <hr align="left" width="50%">
  72 <p>Example 1:
  73 <p><font face="Courier New">Kapu_PCO.clear;</font>
  74 <p>The port Kapu_PCO will be cleared.</p>
  75 <hr align="left" width="50%">
  76 <p><a name="Example 2">Example 2</a>:
  77 <p><font face="Courier New">all port.clear;</font>
  78 <p>The incoming queues of all defined ports will be emptied.</p>
  79 <hr align="left" width="25%">
  80 <hr align="left" width="25%">
  81 <p><a HREF="BNF.html#clearstatement">BNF definition</a> of <font face="Courier New"> clear</font></p>
  82 </body>
  83 </html>