136 lines
8 KiB
XML
136 lines
8 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
|
|
<compounddef id="classtf_1_1WorkerView" kind="class" language="C++" prot="public">
|
|
<compoundname>tf::WorkerView</compoundname>
|
|
<includes refid="worker_8hpp" local="no">taskflow/core/worker.hpp</includes>
|
|
<sectiondef kind="friend">
|
|
<memberdef kind="friend" id="classtf_1_1WorkerView_1a763b2f90bc53f92d680a635fe28e858e" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>class</type>
|
|
<definition>friend class Executor</definition>
|
|
<argsstring></argsstring>
|
|
<name>Executor</name>
|
|
<param>
|
|
<type><ref refid="classtf_1_1Executor" kindref="compound">Executor</ref></type>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/worker.hpp" line="113" column="3" bodyfile="taskflow/core/worker.hpp" bodystart="113" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-attrib">
|
|
<memberdef kind="variable" id="classtf_1_1WorkerView_1ad4df9bf3972a4fe4253fd27477f51808" prot="private" static="no" mutable="no">
|
|
<type>const <ref refid="classtf_1_1Worker" kindref="compound">Worker</ref> &</type>
|
|
<definition>const Worker& tf::WorkerView::_worker</definition>
|
|
<argsstring></argsstring>
|
|
<name>_worker</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/worker.hpp" line="142" column="18" bodyfile="taskflow/core/worker.hpp" bodystart="142" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="public-func">
|
|
<memberdef kind="function" id="classtf_1_1WorkerView_1ab12c901b0bd8a9f1fa33d305a32ae259" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::WorkerView::id</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>id</name>
|
|
<briefdescription>
|
|
<para>queries the worker id associated with its parent executor </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>A worker id is a unsigned integer in the range <computeroutput>[0, N)</computeroutput>, where <computeroutput>N</computeroutput> is the number of workers spawned at the construction time of the executor. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/worker.hpp" line="124" column="12" bodyfile="taskflow/core/worker.hpp" bodystart="151" bodyend="153"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1WorkerView_1afb99c27c8224732921fadb98ceff42e4" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::WorkerView::queue_size</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>queue_size</name>
|
|
<briefdescription>
|
|
<para>queries the size of the queue (i.e., number of pending tasks to run) associated with the worker </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/worker.hpp" line="130" column="12" bodyfile="taskflow/core/worker.hpp" bodystart="156" bodyend="158"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1WorkerView_1aed408a9cbf65b0598fa27cd75d9b915e" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::WorkerView::queue_capacity</definition>
|
|
<argsstring>() const</argsstring>
|
|
<name>queue_capacity</name>
|
|
<briefdescription>
|
|
<para>queries the current capacity of the queue </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/worker.hpp" line="135" column="12" bodyfile="taskflow/core/worker.hpp" bodystart="161" bodyend="163"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-func">
|
|
<memberdef kind="function" id="classtf_1_1WorkerView_1af5023cb4d6b24fab8992310741952bea" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
|
|
<type></type>
|
|
<definition>tf::WorkerView::WorkerView</definition>
|
|
<argsstring>(const Worker &)</argsstring>
|
|
<name>WorkerView</name>
|
|
<param>
|
|
<type>const <ref refid="classtf_1_1Worker" kindref="compound">Worker</ref> &</type>
|
|
<defname>w</defname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/worker.hpp" line="139" column="5" bodyfile="taskflow/core/worker.hpp" bodystart="147" bodyend="148"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1WorkerView_1a4b39c214f3cd23c241faa56f4c94042f" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>tf::WorkerView::WorkerView</definition>
|
|
<argsstring>(const WorkerView &)=default</argsstring>
|
|
<name>WorkerView</name>
|
|
<param>
|
|
<type>const <ref refid="classtf_1_1WorkerView" kindref="compound">WorkerView</ref> &</type>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/core/worker.hpp" line="140" column="5"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
<para>class to create an immutable view of a worker in an executor </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>An executor keeps a set of internal worker threads to run tasks. A worker view provides users an immutable interface to observe when a worker runs a task, and the view object is only accessible from an observer derived from <ref refid="classtf_1_1ObserverInterface" kindref="compound">tf::ObserverInterface</ref>. </para>
|
|
</detaileddescription>
|
|
<location file="taskflow/core/worker.hpp" line="111" column="1" bodyfile="taskflow/core/worker.hpp" bodystart="111" bodyend="144"/>
|
|
<listofallmembers>
|
|
<member refid="classtf_1_1WorkerView_1ad4df9bf3972a4fe4253fd27477f51808" prot="private" virt="non-virtual"><scope>tf::WorkerView</scope><name>_worker</name></member>
|
|
<member refid="classtf_1_1WorkerView_1a763b2f90bc53f92d680a635fe28e858e" prot="private" virt="non-virtual"><scope>tf::WorkerView</scope><name>Executor</name></member>
|
|
<member refid="classtf_1_1WorkerView_1ab12c901b0bd8a9f1fa33d305a32ae259" prot="public" virt="non-virtual"><scope>tf::WorkerView</scope><name>id</name></member>
|
|
<member refid="classtf_1_1WorkerView_1aed408a9cbf65b0598fa27cd75d9b915e" prot="public" virt="non-virtual"><scope>tf::WorkerView</scope><name>queue_capacity</name></member>
|
|
<member refid="classtf_1_1WorkerView_1afb99c27c8224732921fadb98ceff42e4" prot="public" virt="non-virtual"><scope>tf::WorkerView</scope><name>queue_size</name></member>
|
|
<member refid="classtf_1_1WorkerView_1af5023cb4d6b24fab8992310741952bea" prot="private" virt="non-virtual"><scope>tf::WorkerView</scope><name>WorkerView</name></member>
|
|
<member refid="classtf_1_1WorkerView_1a4b39c214f3cd23c241faa56f4c94042f" prot="private" virt="non-virtual"><scope>tf::WorkerView</scope><name>WorkerView</name></member>
|
|
</listofallmembers>
|
|
</compounddef>
|
|
</doxygen>
|