.. _f-aserver: module ``custom_server.aserver`` ================================ .. inheritance-diagram:: pyrsslocal.custom_server.aserver Short summary +++++++++++++ module ``pyrsslocal.custom_server.aserver`` This modules contains a class which implements a simple server. :githublink:`%|py|5` Classes +++++++ +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +=========================================================================================+=============================================================================================================================+ | :class:`CustomDBServer ` | defines a custom server which includes an access to a database, this database will contain de table to store the clicks ... | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomDBServerHandler ` | The server proposes a simple way to create one server on your own. It includes an access to a SQLlite3 database. | +-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Static Methods ++++++++++++++ +-------------------------------------------------------------------------------------+-----------------------------------------+ | staticmethod | truncated documentation | +=====================================================================================+=========================================+ | :meth:`run_server ` | start the server | +-------------------------------------------------------------------------------------+-----------------------------------------+ | :meth:`schema_table ` | returns the schema for a specific table | +-------------------------------------------------------------------------------------+-----------------------------------------+ 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__ ` | constructor | +----------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :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 ` | interpret 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 ` | process an event, and log it | +----------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :meth:`serve_content_web ` | functions to overload (executed after serve_content) | +----------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyrsslocal.custom_server.aserver :members: :special-members: __init__ :show-inheritance: