.. index:: pair: namespace; python_json_engine
.. _doxid-namespacepython__json__engine:

namespace python_json_engine
============================

.. toctree::
	:hidden:

	class_python_json_engine_StandaloneApplication.rst

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	namespace python_json_engine {

	// classes

	class :ref:`StandaloneApplication<doxid-classpython__json__engine_1_1_standalone_application>`;

	// global variables

	int :target:`DEFAULT_TIMEOUT<doxid-namespacepython__json__engine_1a4c26a569c8b353b8daaac267200c2e7d>` =  90;
	int :target:`DEFAULT_WORKERS<doxid-namespacepython__json__engine_1ad73e99dfccedac79ad17bcf99129a6ba>` =  1;
	 :target:`log<doxid-namespacepython__json__engine_1a6df895c4e42add7152b36772bcaaf511>` =  logging.getLogger("werkzeug");
	 :target:`app<doxid-namespacepython__json__engine_1abeadcd9c77f0531c190fac93a62ef53b>` =  Flask(__name__);
	Namespace :target:`args<doxid-namespacepython__json__engine_1a03d4d66a9a72a57024cb32d0192e5b41>` =  :ref:`parse_arguments<doxid-namespacepython__json__engine_1a28943c67b902b70be213235af2e9ed74>`();
	 :target:`hostname<doxid-namespacepython__json__engine_1a0fc72a768700b6cb212f6fcf9f38d2a5>`;
	 :target:`port<doxid-namespacepython__json__engine_1ada0d67c7958ae9138faca7ebb9ce374f>`;
	dict :target:`options<doxid-namespacepython__json__engine_1af42ab5c98a7952e6f6192471af120853>` =  :ref:`prepare_options<doxid-namespacepython__json__engine_1a6b41d62b7fe86fe98ec9497ac1becf88>`(args.options, :ref:`hostname<doxid-namespacepython__json__engine_1a0fc72a768700b6cb212f6fcf9f38d2a5>`, :ref:`port<doxid-namespacepython__json__engine_1ada0d67c7958ae9138faca7ebb9ce374f>`);

	// global functions

	def :ref:`all_exception_handler<doxid-namespacepython__json__engine_1a06b9ecb3ff9549cf04bb4a6aade71c92>`(error error);
	def :target:`initialize<doxid-namespacepython__json__engine_1a6c79e6ba0653aa9eadb8cff8a0d0588d>`();
	def :target:`run_loop<doxid-namespacepython__json__engine_1a0eac150aac6b77a84d912610515549ec>`();
	def :target:`set_datapack<doxid-namespacepython__json__engine_1a1fb82a029d26b62bf0826227ce361092>`();
	def :target:`get_datapack<doxid-namespacepython__json__engine_1af2e56f0af35f218f6202ee015a0ae24f>`();
	def :target:`reset<doxid-namespacepython__json__engine_1a73c8356ee4133ade577c1ea9772f6ed7>`();
	def :target:`shutdown<doxid-namespacepython__json__engine_1afe4562b75299a7560f51cc982d508677>`();
	Namespace :target:`parse_arguments<doxid-namespacepython__json__engine_1a28943c67b902b70be213235af2e9ed74>`();
	bool :ref:`is_port_in_use<doxid-namespacepython__json__engine_1a106e53440be11c72273bc7ae72b8f47a>`(str address, int port);
	int :ref:`find_free_port<doxid-namespacepython__json__engine_1a7e14ead13e59acea3fe2dc8c02d2e1a2>`();
	tuple :target:`extract_hostname_port_from_url<doxid-namespacepython__json__engine_1a0ce54013e174f15fe8b1b7a306b10b97>`(str url);

	None :ref:`register_in_regserver<doxid-namespacepython__json__engine_1a57db730cdc1c9f1791e493126fa8ed1d>`(
		str regserver_url,
		str engine_name,
		str hostname,
		int port
	);

	dict :ref:`parse_extra_options<doxid-namespacepython__json__engine_1ab57a911d4b0fd186307d92c6ba10b721>`(str options_str);
	dict :ref:`prepare_options<doxid-namespacepython__json__engine_1a6b41d62b7fe86fe98ec9497ac1becf88>`(str extra_options, str hostname, int port);

	} // namespace python_json_engine
.. _details-namespacepython__json__engine:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Global Functions
----------------

.. index:: pair: function; all_exception_handler
.. _doxid-namespacepython__json__engine_1a06b9ecb3ff9549cf04bb4a6aade71c92:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	def all_exception_handler(error error)

.. code-block:: cpp

	Custom error handler for error code 500. The default handler returns a html response,
	which doesn't look very nice when printed to terminal.

.. index:: pair: function; is_port_in_use
.. _doxid-namespacepython__json__engine_1a106e53440be11c72273bc7ae72b8f47a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool is_port_in_use(str address, int port)

.. code-block:: cpp

	Checks if given port is already in use

.. index:: pair: function; find_free_port
.. _doxid-namespacepython__json__engine_1a7e14ead13e59acea3fe2dc8c02d2e1a2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int find_free_port()

.. code-block:: cpp

	Returns a random free port number

.. index:: pair: function; register_in_regserver
.. _doxid-namespacepython__json__engine_1a57db730cdc1c9f1791e493126fa8ed1d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	None register_in_regserver(
		str regserver_url,
		str engine_name,
		str hostname,
		int port
	)

.. code-block:: cpp

	Registers in the registration server of the client

.. index:: pair: function; parse_extra_options
.. _doxid-namespacepython__json__engine_1ab57a911d4b0fd186307d92c6ba10b721:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	dict parse_extra_options(str options_str)

.. code-block:: cpp

	Parses the extra server options passed by the user
	Expected format is a python dict: '{ "option1": value1, "option2": value2 }'

.. index:: pair: function; prepare_options
.. _doxid-namespacepython__json__engine_1a6b41d62b7fe86fe98ec9497ac1becf88:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	dict prepare_options(str extra_options, str hostname, int port)

.. code-block:: cpp

	Prepares the dictionary with options for the server application