Relintai/thread_pool
1
0
Fork 0
mirror of https://github.com/Relintai/thread_pool.git synced 2024-11-12 10:25:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source.

Browse Source
This commit is contained in:
Relintai 2020-06-20 23:34:03 +02:00
parent acc7759682
commit 2808b32eba
3 changed files with 179 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
doc_classes/ThreadPool.xml Normal file
View File

@ -0,0 +1,99 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ThreadPool" inherits="Object" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_job">
<return type="void">
</return>
<argument index="0" name="job" type="ThreadPoolJob">
</argument>
<description>
</description>
</method>
<method name="cancel_task">
<return type="void">
</return>
<argument index="0" name="job" type="ThreadPoolJob">
</argument>
<description>
</description>
</method>
<method name="cancel_task_wait">
<return type="void">
</return>
<argument index="0" name="job" type="ThreadPoolJob">
</argument>
<description>
</description>
</method>
<method name="create_execute_job" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="obj" type="Object">
</argument>
<argument index="1" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="create_execute_job_simple">
<return type="ThreadPoolExecuteJob">
</return>
<argument index="0" name="object" type="Variant">
</argument>
<argument index="1" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="get_queued_job">
<return type="ThreadPoolJob">
</return>
<argument index="0" name="object" type="Variant">
</argument>
<argument index="1" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="get_running_job">
<return type="ThreadPoolJob">
</return>
<argument index="0" name="object" type="Variant">
</argument>
<argument index="1" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="register_update">
<return type="void">
</return>
<description>
</description>
</method>
<method name="update">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="max_time_per_frame" type="float" setter="set_max_time_per_frame" getter="get_max_time_per_frame" default="0.00416667">
</member>
<member name="max_work_per_frame_percent" type="float" setter="set_max_work_per_frame_percent" getter="get_max_work_per_frame_percent" default="25.0">
</member>
<member name="thread_count" type="int" setter="set_thread_count" getter="get_thread_count" default="4">
</member>
<member name="use_threads" type="bool" setter="set_use_threads" getter="get_use_threads" default="true">
</member>
</members>
<constants>
</constants>
</class>

23
doc_classes/ThreadPoolExecuteJob.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ThreadPoolExecuteJob" inherits="ThreadPoolJob" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="setup" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="obj" type="Object">
</argument>
<argument index="1" name="method" type="String">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

57
doc_classes/ThreadPoolJob.xml Normal file
View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ThreadPoolJob" inherits="Reference" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_execute" qualifiers="virtual">
<return type="void">
</return>
<description>
</description>
</method>
<method name="execute">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_current_execution_time">
<return type="float">
</return>
<description>
</description>
</method>
<method name="should_do">
<return type="bool">
</return>
<argument index="0" name="just_check" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="should_return">
<return type="bool">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="complete" type="bool" setter="set_complete" getter="get_complete" default="true">
</member>
<member name="current_run_stage" type="int" setter="set_current_run_stage" getter="get_current_run_stage" default="0">
</member>
<member name="limit_execution_time" type="bool" setter="set_limit_execution_time" getter="get_limit_execution_time" default="false">
</member>
<member name="stage" type="int" setter="set_stage" getter="get_stage" default="0">
</member>
<member name="start_time" type="int" setter="set_start_time" getter="get_start_time" default="0">
</member>
</members>
<constants>
</constants>
</class>