.. _f-rsssimpleserver: module ``rss.rss_simple_server`` ================================ .. inheritance-diagram:: pyrsslocal.rss.rss_simple_server Short summary +++++++++++++ module ``pyrsslocal.rss.rss_simple_server`` This modules contains a class which implements a simple server. :githublink:`%|py|5` Classes +++++++ +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +===============================================================================+======================================================================================================================================================================+ | :class:`RSSServer ` | Defines a :epkg:`RSS` server dedicated to one specific database. You can read the blog post `RSS Reader `_. ... | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RSSSimpleHandler ` | You can read the blog post `RSS Reader `_. Defines a simple ... | +-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Static Methods ++++++++++++++ +----------------------------------------------------------------------------+-------------------------+ | staticmethod | truncated documentation | +============================================================================+=========================+ | :meth:`run_server ` | Starts the server. | +----------------------------------------------------------------------------+-------------------------+ Methods +++++++ +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +=============================================================================================================================+===========================================================================================================================+ | :py:meth:`__enter__ ` | What to do when creating the class. | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__exit__ ` | What to do when removing the instance (close the log file). | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Regular constructor, an instance is created for each request, do not store any data for a longer time than a request. ... | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_javascript_paths ` | Returns all the location where the server should look for a java script. | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :meth:`interpret_parameter_as_list_int ` | Interprets a list of parameters, each of them is a list of integer separated by ``,``. | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :meth:`main_page ` | Returns the main page (case the server is called with no path). | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :meth:`process_event ` | Processes an event, it expects a format like the following: | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :meth:`process_event ` | Processes an event, and log it. | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :meth:`serve_content_web ` | Functions to overload (executed after serve_content). | +-----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyrsslocal.rss.rss_simple_server :members: :special-members: __init__ :show-inheritance: