mirror of
https://github.com/Relintai/thread_pool.git
synced 2024-11-14 10:27:51 +01:00
Re-extracted class docs.
This commit is contained in:
parent
a02955e929
commit
9ae53cdd30
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="ThreadPool" inherits="Object" version="3.2">
|
||||
<class name="ThreadPool" inherits="Object" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
@ -8,78 +8,36 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_job">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="job" type="ThreadPoolJob">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="job" type="ThreadPoolJob" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="cancel_task">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="job" type="ThreadPoolJob">
|
||||
</argument>
|
||||
<method name="cancel_job">
|
||||
<return type="void" />
|
||||
<argument index="0" name="job" type="ThreadPoolJob" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="cancel_task_wait">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="job" type="ThreadPoolJob">
|
||||
</argument>
|
||||
<method name="cancel_job_wait">
|
||||
<return type="void" />
|
||||
<argument index="0" name="job" type="ThreadPoolJob" />
|
||||
<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>
|
||||
<method name="has_job">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="job" type="ThreadPoolJob" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="register_update">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="update">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -89,7 +47,9 @@
|
||||
</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 name="thread_count" type="int" setter="set_thread_count" getter="get_thread_count" default="5">
|
||||
</member>
|
||||
<member name="thread_fallback_count" type="int" setter="set_thread_fallback_count" getter="get_thread_fallback_count" default="4">
|
||||
</member>
|
||||
<member name="use_threads" type="bool" setter="set_use_threads" getter="get_use_threads" default="true">
|
||||
</member>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="ThreadPoolExecuteJob" inherits="ThreadPoolJob" version="3.2">
|
||||
<class name="ThreadPoolExecuteJob" inherits="ThreadPoolJob" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
@ -8,12 +8,9 @@
|
||||
</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>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="obj" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="ThreadPoolJob" inherits="Reference" version="3.2">
|
||||
<class name="ThreadPoolJob" inherits="Reference" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
@ -8,50 +8,57 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_execute" qualifiers="virtual">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="execute">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_execution_time">
|
||||
<return type="float">
|
||||
</return>
|
||||
<return type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="reset_stages">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="should_do">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="just_check" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="just_check" type="bool" default="false" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="should_return">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="cancelled" type="bool" setter="set_cancelled" getter="get_cancelled" default="false">
|
||||
</member>
|
||||
<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 name="max_allocated_time" type="float" setter="set_max_allocated_time" getter="get_max_allocated_time" default="0.0">
|
||||
</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>
|
||||
<signals>
|
||||
<signal name="completed">
|
||||
<description>
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user