/usr/share/doc/gnat-gps/html/The-Server-Mode.html

<html lang="en">
<head>
<title>The Server Mode - Using the GNAT Programming Studio</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Using the GNAT Programming Studio">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS" title="Customizing and Extending GPS">
<link rel="prev" href="Adding-support-for-new-Version-Control-Systems.html#Adding-support-for-new-Version-Control-Systems" title="Adding support for new Version Control Systems">
<link rel="next" href="Adding-project-templates.html#Adding-project-templates" title="Adding project templates">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2002-2010 AdaCore.

This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see `http://www.gnu.org/licenses/'.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
pre.smallexample {background-color:rgb(240,240,240);
                     font-family: courier new,courier,fixed;
                     font-size: 14px;
                     margin: 0px 40px 0px 40px;
                     border-width: 1px 2px 2px 1px;
                     border-top-style: dotted;
                     border-left-style: dotted;
                     border-right-style: solid;
                     border-bottom-style: solid;
                     border-color: black;}
   code             {color:black;
                     font-family: courier new,courier,fixed;
                     font-size: 14px;}
   body             {font-family: arial,helvetica,sans-serif;
                     font-size: 16px;
                     max-width: 800px;
                     text-align: justify}
   samp             {font-family: courier new,courier,fixed;
                     font-size: 14px}
                    
--></style>
</head>
<body>
<div class="node">
<a name="The-Server-Mode"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Adding-project-templates.html#Adding-project-templates">Adding project templates</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Adding-support-for-new-Version-Control-Systems.html#Adding-support-for-new-Version-Control-Systems">Adding support for new Version Control Systems</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS">Customizing and Extending GPS</a>
<hr>
</div>

<h3 class="section">16.10 The Server Mode</h3>

<p><a name="index-server-911"></a><!--  -->

<p class="noindent">In order to give access to the GPS capabilities from external processes
(e.g. <code>Emacs</code>), GPS can be launched in <i>server mode</i>.

   <p>The two relevant command line switches are <code>--server</code> and
<code>--hide</code>.

   <p><code>--server</code> will open a socket on the given port, allowing multiple
clients to connect to a running GPS, and sending GPS shell or python
commands.

   <p><code>--hide</code> tells GPS not to display its main window when starting. 
note that under unix systems, you still need to have access to the current
screen (as determined by the <code>DISPLAY</code> environment variable) in this
mode.

   <p>Using the two switches together provides a way to launch GPS as a background
process with no initial user interface.

   <p>Clients connecting through a standard socket have access to a simple
shell using <code>GPS&gt;&gt; </code> as the separating prompt between each command. This
is needed in order to determine when the output (result) of a command
is terminated.

   <p>All the GPS shell commands (as defined in <a href="The-GPS-Shell.html#The-GPS-Shell">The GPS Shell</a>) are
available from this shell. In addition, the python interpreter, if
enabled, is also available through the use of the <code>python</code> prefix
before a python command.

   <p>For example, sending <code>pwd</code> through the socket will send the <code>pwd</code>
command through the GPS shell and display the result on the socket;
similarly, sending <code>python GPS.pwd()</code> will send the <code>GPS.help()</code>
command through the python interpreter (see <a href="The-Python-Interpreter.html#The-Python-Interpreter">The Python Interpreter</a> for
more details).

   <p>The socket shell provides also additional commands:

     <ul>
<li>logout
This command will inform the GPS server that the connection should now
be closed.

     <li>id &lt;string&gt;
This command will register the current session with a given string. 
This string can then be used within GPS itself (for example via a
.xml or python plug-in) to display extra information to the client via
the socket, using the command GPS.Socket().send. 
</ul>

   <p>For example, let suppose that we start gps with the <code>--server=1234</code>
command: this will bring up GPS as usual.

   <p>Now, on a separate terminal, create a simple client by typing the following:

<pre class="smallexample">     telnet localhost 1234
     Trying 127.0.0.1...
     Connected to localhost.
     Escape character is '^]'.
     GPS&gt;&gt; id test-1
     id set to 'test-1'
     GPS&gt;&gt; pwd
     c:\working-dir\
     GPS&gt;&gt;
</pre>
   <p>Then in the GPS Python Console:

<pre class="smallexample">     &gt;&gt;&gt; GPS.Socket ("test-1").send ("hello, it's time to logout\n");
</pre>
   <p>At this point, the following is received on the client (telnet) side:

<pre class="smallexample">     GPS&gt;&gt; hello, it's time to logout
</pre>
   <p>We can then close the client:

<pre class="smallexample">     logout
     Connection closed by foreign host.
</pre>
   <!--  -->
   </body></html>
gnat-gps-doc 5.0-6 / usr / share / doc / gnat-gps / html / The-Server-Mode.html
