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

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 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 2 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/.

A copy of the license is included in the section entitled
"GNU General Public License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using the GNAT Programming Studio: The Server Mode</title>

<meta name="description" content="Using the GNAT Programming Studio: The Server Mode">
<meta name="keywords" content="Using the GNAT Programming Studio: The Server Mode">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-table.html#Index-table" rel="index" title="Index table">
<link href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS" rel="up" title="Customizing and Extending GPS">
<link href="Adding-project-templates.html#Adding-project-templates" rel="next" title="Adding project templates">
<link href="Implementing-VCS-actions.html#Implementing-VCS-actions" rel="previous" title="Implementing VCS actions">
<style type="text/css">
<!--
   

a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
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 lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="The-Server-Mode"></a>
<div class="header">
<p>
Next: <a href="Adding-project-templates.html#Adding-project-templates" accesskey="n" rel="next">Adding project templates</a>, Previous: <a href="Adding-support-for-new-Version-Control-Systems.html#Adding-support-for-new-Version-Control-Systems" accesskey="p" rel="previous">Adding support for new Version Control Systems</a>, Up: <a href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS" accesskey="u" rel="up">Customizing and Extending GPS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="The-Server-Mode-1"></a>
<h3 class="section">16.10 The Server Mode</h3>
<a name="index-server-2"></a>

<p>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>
<p>The two relevant command line switches are <code>--server</code> and
<code>--hide</code>.
</p>
<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>
<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>
<p>Using the two switches together provides a way to launch GPS as a background
process with no initial user interface.
</p>
<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>
<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>
<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>
<p>The socket shell provides also additional commands:
</p>
<ul>
<li> logout
This command will inform the GPS server that the connection should now
be closed.

</li><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.
</li></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>
<p>Now, on a separate terminal, create a simple client by typing the following:
</p>
<div class="smallexample">
<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></div>

<p>Then in the GPS Python Console:
</p>
<div class="smallexample">
<pre class="smallexample">&gt;&gt;&gt; GPS.Socket (&quot;test-1&quot;).send (&quot;hello, it's time to logout\n&quot;);
</pre></div>

<p>At this point, the following is received on the client (telnet) side:
</p>
<div class="smallexample">
<pre class="smallexample">GPS&gt;&gt; hello, it's time to logout
</pre></div>

<p>We can then close the client:
</p>
<div class="smallexample">
<pre class="smallexample">logout
Connection closed by foreign host.
</pre></div>

<hr>
<div class="header">
<p>
Next: <a href="Adding-project-templates.html#Adding-project-templates" accesskey="n" rel="next">Adding project templates</a>, Previous: <a href="Adding-support-for-new-Version-Control-Systems.html#Adding-support-for-new-Version-Control-Systems" accesskey="p" rel="previous">Adding support for new Version Control Systems</a>, Up: <a href="Customizing-and-Extending-GPS.html#Customizing-and-Extending-GPS" accesskey="u" rel="up">Customizing and Extending GPS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / The-Server-Mode.html
