:orphan:

.. _section_example_fastrocs_shapedatabaseserver:

ShapeDatabaseServer
======================

.. code-block::

   ShapeDatabaseServer.py <database> [portnumber=8080]

Runs the FastROCS Server.  The preferred usage of ShapeDatabaseServer.py is as a
service that is left continuously running to avoid the overhead of
reading and parsing the database off disk. Run the above command to start a
server on a suitable host. By default the service will run on port 8080, though
this can be changed by the last command line option.

The server will output dots while loading the database into memory,
which can take a considerable amount of time. When the server is done
loading the database it will report a total and then go to sleep
waiting for queries on the specified port. Queries are serviced
through the XMLRPC protocol using the built-in libraries that ship
with a standard python distribution.

.. note::

   The database load time can be significantly improved by running
   ShapeDatabasePrep.py on the file first and saving it as uncompressed
   OEB. The ShapeDatabaseChunker.py program described later will perform
   such caching.

.. note::

   The server/client examples are for use with the **FastROCS Toolkit** product, only.
   They are not compatible with the commercially supported **FastROCS server** product,
   which provides an independent GUI and CLI.
   For more information about the commercially supported server please visit https://www.eyesopen.com/contact.


.. only:: oehtml

   .. admonition:: Download code

         :download:`ShapeDatabaseServer.py <../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseServer.py>`

      .. :ref:`Full listing. <listing-ShapeDatabaseServer.py>`

      .. literalinclude:: ../../../../../wrappers/python/examples/fastrocs/ShapeDatabaseServer.py


.. only:: oepdf

   .. oe:source:: ShapeDatabaseServer.py
      :language: python


