help/info/send.html

   1 <!--
   2  Copyright (c) 2000-2015 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>send</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="self.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a href="sender.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>send</h1>
  33 <hr align="left" width="75%">
  34 <p>The asynchronous operation belongs to the family of message-based communication operations. It is used to place a value on an outgoing message port.
  35 <ul>
  36   <li>The operation can be used on connected ports.</li>
  37   <li>The operation is non-blocking (does not block TTCN3 program execution).</li>
  38   <li>In case of multiple connections the receiver may be addressed.</li>
  39 </ul>
  40 <p>Related keywords:</p>
  41 <ul>
  42   <li><a href="address.html"><b><font face="Courier New" color="#003258" size="4">address</font></b></a></li>
  43   <li><a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a></li>
  44   <li><a href="modifies.html"><b><font face="Courier New" color="#003258" size="4">modifies</font></b></a></li>
  45   <li><a href="system.html"><b><font face="Courier New" color="#003258" size="4">system</font></b></a></li>
  46   <li><a href="to.html"><b><font face="Courier New" color="#003258" size="4">to</font></b></a></li>
  47 </ul>
  48 <hr align="left" width="50%">
  49 <div align="center">
  50 <center>
  51 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  52   <tr>
  53     <td width="100%">
  54     <h3 align="center"><i>port_reference</i><font face="Courier New" color="#003258" size="5"><b>.send (</b></font><i> value_part </i><font face="Courier New" color="#003258" size="5"><b>)
  55     </b></font>[ <font face="Courier New" color="#003258" size="5"><b>to </b></font><i>address_reference</i> ]<font face="Courier New" color="#003258" size="5"><b>;</b></font> &nbsp;</h3>
  56     </td>
  57   </tr>
  58 </table>
  59 </center>
  60 </div>
  61 <ul>
  62   <li>
  63   <p><i> port_reference</i> points out the outgoing message port.</p>
  64   </li>
  65   <li>
  66   <p>The <b><font face="Courier New" color="#003258" size="4">send</font> </b> keyword introduces the message sending.</p>
  67   </li>
  68   <li>
  69   <p><i>value_part</i> is one of the following:</p>
  70   <ul>
  71     <li>a literal value, a constant, a variable, an expression. (see the <a href="#Example 1">example1</a>)</li>
  72     <li>a specific value template (see the <a href="#Example 2">example 2</a>)</li>
  73     <li>a modified template (see the <a href="#Example 3">example 3</a>)<br>
  74     &nbsp;</li>
  75   </ul>
  76   </li>
  77   <table border="0" width="100%" bgcolor="#C9C2BB" cellpadding="4">
  78     <tr>
  79       <td width="100%">
  80       <li>
  81       <p>The optional<b><font face="Courier New" color="#003258" size="4">to</font> </b> keyword is used when a port is connected to several entities and identification of the communication
  82       partner is required.</p>
  83       </li>
  84       </ul>
  85       <ul>
  86         <li>
  87         <p><i>address_reference</i> is one of the following:</p>
  88         <ul>
  89           <li>a component reference (cf. <a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a>)&nbsp; or the keyword <a
  90             href="system.html" target="_blank"><b><font face="Courier New" color="#003258" size="4">system</font></b></a>, in case of one-to-many connections.</li>
  91           <li>an address reference (cf. <a href="address.html"><b><font face="Courier New" color="#003258" size="4">address</font></b></a>) , when there are several entities
  92           within the system under test.</li>
  93         </ul>
  94         </li>
  95       </ul>
  96       <hr align="left" width="50%">
  97       <p><a name="Example 1">Example 1</a>: literal value
  98       <p><font face="Courier New">Portus_PCO.send (charstring:&quot;bla&quot;) to system;</font>
  99       <p>The character string bla is sent over the port Portus_PCO to the test system interface. The port is connected to several components.</p>
 100       <hr align="left" width="50%">
 101       <p><a name="Example 2">Example 2</a>: template</p>
 102       <p><font face="Courier New">template DefinedRecordType t_MeusTemplate (integer pl_param) := {<br>
 103       &nbsp;&nbsp;&nbsp;field1 := 16,<br>
 104       &nbsp;&nbsp;&nbsp;field2 := pl_param<br>
 105       }</font>
 106       <p><font face="Courier New">Portus_PCO.send (t_MeusTemplate(116));</font></p>
 107       <p>The parameterized template (t_MeusTemplate) has two integer fields. When sent as shown in the second line, the values 16 and 116 will be sent to the port Portus_PCO.</p>
 108       <hr align="left" width="50%">
 109       <p><a name="Example 3">Example 3</a>: modified template</p>
 110       <p><font face="Courier New">Portus_PCO.send (modifies t_MeusTemplate(116) := {field1 := 117});</font></p>
 111       <p>The template defined in example 2 is modified. When sent as shown, the values 117 and 116 will be sent to the port Portus_PCO.</p>
 112       <hr align="left" width="25%">
 113       <hr align="left" width="25%">
 114       <p><a HREF="BNF.html#sendstatement">BNF definition</a> of <font face="Courier New"> send</font></p>
 115 </body>
 116 </html>