crawlservpp::Struct::AlgoThreadProperties Struct Reference
Properties of an algorithm thread. More...
#include <AlgoThreadProperties.hpp>
Collaboration diagram for crawlservpp::Struct::AlgoThreadProperties:
Properties | |
| std::uint32_t | algoId |
| The ID of the algorithm run by the thread. More... | |
| ThreadOptions | options |
| Options used for the algorithm thread. More... | |
| ThreadStatus | status |
| Status of the algorithm thread. More... | |
Database Reference | |
| Main::Database & | dbBase |
| Reference to the database instance used by the thread. More... | |
Construction and Destruction | |
| AlgoThreadProperties (std::uint32_t setAlgoId, const ThreadOptions &setOptions, Main::Database &setDatabase) | |
| Constructor setting properties for a newly created thread. More... | |
| AlgoThreadProperties (std::uint32_t setAlgoId, const ThreadOptions &setOptions, const ThreadStatus &setStatus, Main::Database &setDatabase) | |
| Constructor setting properties for a previously interrupted thread. More... | |
| virtual | ~AlgoThreadProperties ()=default |
| Default destructor. More... | |
Copy and Move | |
| AlgoThreadProperties (AlgoThreadProperties &)=delete | |
| Deleted copy constructor. More... | |
| AlgoThreadProperties & | operator= (AlgoThreadProperties &)=delete |
| Deleted copy assignment operator. More... | |
| AlgoThreadProperties (AlgoThreadProperties &&)=delete | |
| Deleted move constructor. More... | |
| AlgoThreadProperties & | operator= (AlgoThreadProperties &&)=delete |
| Deleted move assignment operator. More... | |
Detailed Description
Properties of an algorithm thread.
Constructor & Destructor Documentation
◆ AlgoThreadProperties() [1/4]
|
inline |
Constructor setting properties for a newly created thread.
- Parameters
-
setAlgoId The ID of the algorithm used by the newly created thread. setOptions Constant reference to the options used by the newly created thread. setDatabase Reference to the database instance used by the newly created thread.
Referenced by AlgoThreadProperties().
◆ AlgoThreadProperties() [2/4]
|
inline |
Constructor setting properties for a previously interrupted thread.
- Parameters
-
setAlgoId The ID of the algorithm used by the previously interrupted thread. setOptions Constant reference to the options used by the previously interrupted thread. setStatus Constant reference to the status of the algorithm thread. setDatabase Reference to the database instance used by the previously interrupted thread.
- Exceptions
-
Main::Exception if the specified status contains an invalid thread ID, i.e. zero.
References AlgoThreadProperties(), crawlservpp::Struct::ThreadStatus::id, operator=(), and ~AlgoThreadProperties().
◆ ~AlgoThreadProperties()
|
virtualdefault |
Default destructor.
Referenced by AlgoThreadProperties().
◆ AlgoThreadProperties() [3/4]
|
delete |
Deleted copy constructor.
◆ AlgoThreadProperties() [4/4]
|
delete |
Deleted move constructor.
Member Function Documentation
◆ operator=() [1/2]
|
delete |
Deleted copy assignment operator.
Referenced by AlgoThreadProperties().
◆ operator=() [2/2]
|
delete |
Deleted move assignment operator.
Member Data Documentation
◆ algoId
| std::uint32_t crawlservpp::Struct::AlgoThreadProperties::algoId |
The ID of the algorithm run by the thread.
◆ dbBase
| Main::Database& crawlservpp::Struct::AlgoThreadProperties::dbBase |
Reference to the database instance used by the thread.
◆ options
| ThreadOptions crawlservpp::Struct::AlgoThreadProperties::options |
Options used for the algorithm thread.
◆ status
| ThreadStatus crawlservpp::Struct::AlgoThreadProperties::status |
Status of the algorithm thread.
Will be empty, if the thread has not been previously interrupted.
The documentation for this struct was generated from the following file:
- Struct/AlgoThreadProperties.hpp
