xan/awips2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
awips2/cave/com.raytheon.viz.gfe/help/sendGfeMessage.html
root a02aeb236c Initial revision of AWIPS2 11.9.0-7p5 
Former-commit-id: 06a8b51d6d [formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]
Former-commit-id: 9f19e3f712
2012-01-06 08:55:05 -06:00

190 lines
6.1 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="Author" content="Mark Mathewson">
<meta name="GENERATOR"
content="Mozilla/4.78 [en] (X11; U; Linux 2.4.9-13smp i686) [Netscape]">
<title>sendGfeMessage</title>
</head>
<body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000"
vlink="#551a8b">
<h1>sendGfeMessage User's Guide</h1>
May 14, 2004<br>
<hr width="100%">
<br>
The sendGfeMessage program is part of the GFESuite software.&nbsp;
It takes a message specified on the command line and broadcasts it to
all connected clients through the ifpServer.&nbsp; The message, when
received by the GFE, is displayed on the status bar.<br>
<hr width="100%">
<h2>Running the program</h2>
<h3>
Command Line Switches</h3>
The command line syntax is:
<br>
<p><b><tt>sendGfeMessage -h hostname -p rpcport [-r] [-s] [-u] [-c
class] -m message</tt></b>
</p>
<p>&nbsp;
&nbsp;<br>
<table border="1" width="100%">
<tbody>
<tr>
<td>Command Switch</td>
<td>Optional or Mandatory?</td>
<td>Description</td>
</tr>
<tr>
<td>-h</td>
<td>Mandatory (see Note)</td>
<td>Host name upon which the ifpServer is running</td>
</tr>
<tr>
<td>-p</td>
<td>Mandatory (see Note)</td>
<td>RPC port upon which the ifpServer is running</td>
</tr>
<tr>
<td style="vertical-align: top;">-r<br>
</td>
<td style="vertical-align: top;">Optional<br>
</td>
<td style="vertical-align: top;">Send as a routine message.
(default)<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">-s<br>
</td>
<td style="vertical-align: top;">Optional<br>
</td>
<td style="vertical-align: top;">Send as a significant message.<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">-u<br>
</td>
<td style="vertical-align: top;">Optional<br>
</td>
<td style="vertical-align: top;">Send as an urgent message.&nbsp;
Urgent messages in the GFE will display a red banner.<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">-a<br>
</td>
<td style="vertical-align: top;">Optional<br>
</td>
<td style="vertical-align: top;">Send as an alert message.&nbsp;
Alert messages in the GFE only appear in the status bar.<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">-c<br>
</td>
<td style="vertical-align: top;">Optional<br>
</td>
<td style="vertical-align: top;">Message class, used by GFE to
determine whether message should appear in the left or right status
bar.&nbsp; Default is "GFE", which appears in the left status bar.<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">-m<br>
</td>
<td style="vertical-align: top;">Mandatory<br>
</td>
<td style="vertical-align: top;">Message contents.<br>
</td>
</tr>
</tbody>
</table>
<font color="#3366ff">Note:&nbsp;The -h and -p switches are predefined
when running in an installed GFESuite environment.&nbsp; They are
defined
to the values specified when installing the software.&nbsp; If you wish
to connect to a different ifpServer, then the switches will need to be
specified.</font>
<font color="#3366ff">&nbsp; If environment variables ${CDSHOST} or
${CDSPORT} are defined, then the default server and port will be
determined from the environment variables, unless overridden with the
user specified -h and -p switches.<br>
</font></p>
<p><font color="#3366ff"><span style="color: rgb(0, 0, 0);">The Message
Classes that the GFE currently uses are shown in the following table:</span></font></p>
<p><font color="#3366ff"><span style="color: rgb(0, 0, 0);"></span></font></p>
<table style="width: 100%; text-align: left;" border="1" cellpadding="2"
cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top; font-weight: bold;">Message Class<br>
</td>
<td style="vertical-align: top; font-weight: bold;">Description<br>
</td>
<td style="vertical-align: top; font-weight: bold;">Appearance on
GFE Status Bar<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">SMARTINIT<br>
</td>
<td style="vertical-align: top;">Used by smart initialization
processes to inform the forecaster that new model data has been
processed.<br>
</td>
<td style="vertical-align: top;">Right status bar<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">ISC<br>
</td>
<td style="vertical-align: top;">Used by the ISC processing that
new ISC data has been received and processed.<br>
</td>
<td style="vertical-align: top;">Right status bar<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">NDFD<br>
</td>
<td style="vertical-align: top;">Message used by the NDFD central
server to alert forecasters to NDFD issues on missing grids, etc.<br>
</td>
<td style="vertical-align: top;">Right status bar<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">GFE<br>
</td>
<td style="vertical-align: top;">General GFE status messages.<br>
</td>
<td style="vertical-align: top;">Left status bar<br>
</td>
</tr>
</tbody>
</table>
<p><font color="#3366ff"><span style="color: rgb(0, 0, 0);"><br>
</span></font></p>
<hr width="100%">
<h3>Sample Output</h3>
<tt></tt>
<p style="font-weight: bold; font-family: monospace;">sendGfeMessage -r
-c GFE -m "test from sendGfeMessage"</p>
<p><tt>19:04:50.709 SendGfeMessage.py 69 EVENT:&nbsp; SendUserMessage
starting<br>
19:04:50.722 Client.C 161 EVENT: Establishing connection to server on
polaris:98000000 ver=20030321<br>
19:04:50.740 Client.C 181 EVENT: Connection complete to server on
polaris<br>
19:04:50.754 SendGfeMessage.py 60 EVENT:&nbsp; sending: test from
sendGfeMessage&nbsp; type= 0&nbsp; class= GFE<br>
19:04:50.763 SendGfeMessage.py 69 EVENT:&nbsp; SendUserMessage finished</tt><br>
<tt></tt>&nbsp;
</p>
<p></p>
<hr width="100%"><br>
<a href="GFESuite.html">Return to Table of Contents</a>
</body>
</html>
Reference in a new issue View git blame Copy permalink