pandemonium_engine/modules/http_server_simple/doc_classes/WebServerSimple.xml
2024-03-10 10:10:02 +01:00

76 lines
3.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebServerSimple" inherits="WebServer" version="4.3">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_mime_type">
<return type="void" />
<argument index="0" name="file_extension" type="String" />
<argument index="1" name="mime_type" type="String" />
<description>
</description>
</method>
<method name="is_running" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
<method name="remove_mime_type">
<return type="void" />
<argument index="0" name="file_extension" type="String" />
<description>
</description>
</method>
</methods>
<members>
<member name="bind_host" type="String" setter="set_bind_host" getter="get_bind_host" default="&quot;0.0.0.0&quot;">
</member>
<member name="bind_port" type="int" setter="set_bind_port" getter="get_bind_port" default="8080">
</member>
<member name="max_request_size" type="int" setter="set_max_request_size" getter="get_max_request_size" default="3">
</member>
<member name="max_request_size_type" type="int" setter="set_max_request_size_type" getter="get_max_request_size_type" enum="WebServerSimple.MaxRequestSizeTypes" default="2">
</member>
<member name="ssl_cert" type="String" setter="set_ssl_cert" getter="get_ssl_cert" default="&quot;&quot;">
</member>
<member name="ssl_key" type="String" setter="set_ssl_key" getter="get_ssl_key" default="&quot;&quot;">
</member>
<member name="start_on_ready" type="bool" setter="set_start_on_ready" getter="get_start_on_ready" default="false">
</member>
<member name="upload_file_store_type" type="int" setter="upload_set_file_store_type" getter="upload_get_file_store_type" enum="WebServerSimple.FileUploadStoreType" default="0">
</member>
<member name="upload_request_max_file_size" type="int" setter="upload_set_request_max_file_size" getter="upload_get_request_max_file_size">
</member>
<member name="upload_request_max_file_size_type" type="int" setter="upload_set_request_max_file_size_type" getter="upload_get_request_max_file_size_type" enum="WebServerSimple.MaxRequestSizeTypes">
</member>
<member name="upload_temp_file_store_path" type="String" setter="upload_set_temp_file_store_path" getter="upload_get_temp_file_store_path">
</member>
<member name="use_poll_thread" type="bool" setter="set_use_poll_thread" getter="get_use_poll_thread" default="true">
</member>
<member name="use_ssl" type="bool" setter="set_use_ssl" getter="get_use_ssl" default="false">
</member>
<member name="use_worker_threads" type="bool" setter="set_use_worker_threads" getter="get_use_worker_threads" default="true">
</member>
<member name="worker_thread_count" type="int" setter="set_worker_thread_count" getter="get_worker_thread_count" default="4">
</member>
</members>
<constants>
<constant name="MAX_REQUEST_SIZE_TYPE_BYTE" value="0" enum="MaxRequestSizeTypes">
</constant>
<constant name="MAX_REQUEST_SIZE_TYPE_KILO_BYTE" value="1" enum="MaxRequestSizeTypes">
</constant>
<constant name="MAX_REQUEST_SIZE_TYPE_MEGA_BYTE" value="2" enum="MaxRequestSizeTypes">
</constant>
<constant name="MAX_REQUEST_SIZE_TYPE_GIGA_BYTE" value="3" enum="MaxRequestSizeTypes">
</constant>
<constant name="FILE_UPLOAD_STORE_TYPE_MEMORY" value="0" enum="FileUploadStoreType">
</constant>
<constant name="FILE_UPLOAD_STORE_TYPE_TEMP_FILES" value="1" enum="FileUploadStoreType">
</constant>
</constants>
</class>