projects / deliverable / titan.core.git / blame
| Commit | Line | Data |
|---|---|---|
| 970ed795 | 1 | <!-- |
| d44e3c4f | 2 | Copyright (c) 2000-2016 Ericsson Telecom AB |
| 970ed795 EL |
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 | |
| d44e3c4f | 7 | |
| 8 | Contributors: | |
| 9 | Baji, Laszlo | |
| 10 | Balasko, Jeno | |
| 11 | Farkas, Laszlo | |
| 12 | Szabados, Kristof | |
| 13 | --> | |
| 970ed795 EL |
14 | <html> |
| 15 | <head> | |
| 16 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | |
| 17 | <meta http-equiv="Content-Language" content="en-us"> | |
| 18 | <title>clear</title> | |
| 19 | </head> | |
| 20 | <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258"> | |
| 21 | <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top> | |
| 22 | <tr> | |
| 23 | <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> | |
| 24 | </tr> | |
| 25 | </table> | |
| 26 | <table border="0" align="right" cellpadding="0" cellspacing="0"> | |
| 27 | <tr> | |
| 28 | <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td> | |
| 29 | <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td> | |
| 30 | <td><a href="check.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td> | |
| 31 | <td><a href="complement.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td> | |
| 32 | </tr> | |
| 33 | </table> | |
| 34 | <p><br clear="all"> | |
| 35 | </p> | |
| 36 | <hr> | |
| 37 | <h1>clear</h1> | |
| 38 | <hr align="left" width="75%"> | |
| 39 | <p>The keyword is used to remove the contents of the incoming queue of the specified communication port. | |
| 40 | <ul> | |
| 41 | <li>The operation is valid for both message and procedure based ports.</li> | |
| 42 | <li>It is possible to clear all defined ports.</li> | |
| 43 | <li>If the port queue is already empty then this operation has no action.</li> | |
| 44 | </ul> | |
| 45 | <p>Related keywords:</p> | |
| 46 | <ul> | |
| 47 | <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li> | |
| 48 | <li><a href="port.html"><b><font face="Courier New" color="#003258" size="4">port</font></b></a></li> | |
| 49 | </ul> | |
| 50 | <hr align="left" width="50%"> | |
| 51 | <div align="center"> | |
| 52 | <center> | |
| 53 | <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4"> | |
| 54 | <tr> | |
| 55 | <td width="100%"> | |
| 56 | <h3 align="center"><i>port_reference</i><font face="Courier New" color="#003258" size="5"><b>.clear;</b></font></h3> | |
| 57 | </td> | |
| 58 | </tr> | |
| 59 | </table> | |
| 60 | </center> | |
| 61 | </div> | |
| 62 | <ul> | |
| 63 | <li> | |
| 64 | <p><i> port_reference</i> points out the port to be cleared.</p> | |
| 65 | <ul> | |
| 66 | <li> | |
| 67 | <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 | |
| 68 | 2</a>).</p> | |
| 69 | </li> | |
| 70 | </ul> | |
| 71 | </li> | |
| 72 | <li> | |
| 73 | <p>The <b><font face="Courier New" color="#003258" size="4">clear</font> </b> keyword introduces port cleansing.</p> | |
| 74 | </li> | |
| 75 | </ul> | |
| 76 | <hr align="left" width="50%"> | |
| 77 | <p>Example 1: | |
| 78 | <p><font face="Courier New">Kapu_PCO.clear;</font> | |
| 79 | <p>The port Kapu_PCO will be cleared.</p> | |
| 80 | <hr align="left" width="50%"> | |
| 81 | <p><a name="Example 2">Example 2</a>: | |
| 82 | <p><font face="Courier New">all port.clear;</font> | |
| 83 | <p>The incoming queues of all defined ports will be emptied.</p> | |
| 84 | <hr align="left" width="25%"> | |
| 85 | <hr align="left" width="25%"> | |
| 86 | <p><a HREF="BNF.html#clearstatement">BNF definition</a> of <font face="Courier New"> clear</font></p> | |
| 87 | </body> | |
| 88 | </html> |