Ship::ThreadPool Class Reference

Component wrapper around a BS::thread_pool. More...

#include <ThreadPool.h>

Inheritance diagram for Ship::ThreadPool:

Collaboration diagram for Ship::ThreadPool:

Public Member Functions
	ThreadPool (size_t threadCount)
	Constructs a ThreadPool with the given number of worker threads.
	~ThreadPool () override=default
std::shared_ptr< BS::thread_pool >	Get () const
	Returns the underlying thread pool.
void	Pause ()
	Pauses the thread pool, preventing it from picking up new tasks.
void	Unpause ()
	Unpauses the thread pool, allowing it to resume picking up tasks.
Public Member Functions inherited from Ship::Component
	Component (const std::string &name, std::shared_ptr< Context > context=nullptr)
	Constructs a Component with the given name.
virtual	~Component ()
void	Init (const nlohmann::json &initArgs=nlohmann::json::object())
	Performs one-time initialization of this component.
bool	IsInitialized () const
	Returns true once Init() (or MarkInitialized()) has completed successfully.
const std::string &	GetName () const
	Returns the name of this Component.
std::string	ToString () const
	Returns a human-readable string representation (e.g. "Name (id)").
std::string	ToTreeString (int depth=0) const
	Returns a human-readable tree representation of this component and its children.
	operator std::string () const
	Conversion operator to std::string; equivalent to ToString().
ParentComponentList &	GetParents ()
	Returns a mutable reference to the parent list.
const ParentComponentList &	GetParents () const
	Returns a const reference to the parent list.
ComponentList &	GetChildren ()
	Returns a mutable reference to the child list.
const ComponentList &	GetChildren () const
	Returns a const reference to the child list.
virtual std::shared_ptr< Component >	TryGetSharedComponent () noexcept
	Returns a shared_ptr to this Component when available, otherwise nullptr.
virtual std::shared_ptr< Component >	GetSharedComponent ()
	Returns a shared_ptr to this Component via the correct enable_shared_from_this base.
template<typename T >
bool	HasInChildren () const
	Checks whether any descendant Component matches type T via BFS.
template<typename T >
std::shared_ptr< T >	GetFirstInChildren () const
	Returns the first descendant that matches type T via BFS.
template<typename T >
std::shared_ptr< std::vector< std::shared_ptr< T > > >	GetInChildren () const
	Returns all descendants that match type T via BFS.
template<typename T >
bool	HasInParents () const
	Checks whether any ancestor Component matches type T via BFS.
template<typename T >
std::shared_ptr< T >	GetFirstInParents () const
	Returns the first ancestor that matches type T via BFS.
template<typename T >
std::shared_ptr< std::vector< std::shared_ptr< T > > >	GetInParents () const
	Returns all ancestors that match type T via BFS.
Public Member Functions inherited from Ship::Part
	Part ()
	Constructs a Part and assigns it a unique ID.
	Part (std::shared_ptr< Context > context)
	Constructs a Part with an explicit Context reference and unique ID.
virtual	~Part ()=default
uint64_t	GetId () const
	Returns the unique identifier for this Part.
bool	operator== (const Part &other) const
	Compares two Parts for equality by their unique IDs.
std::shared_ptr< Context >	GetContext () const
	Returns the Context this Part belongs to, or nullptr if unset.
void	SetContext (std::shared_ptr< Context > ctx)
	Sets the Context this Part belongs to.

Additional Inherited Members
Protected Member Functions inherited from Ship::Component
virtual void	OnInit (const nlohmann::json &initArgs=nlohmann::json::object())
	Override this to implement component-specific initialization logic.
void	MarkInitialized ()
	Marks this component as initialized without going through Init().
template<typename T >
std::shared_ptr< T >	RequireDependency (const std::shared_ptr< T > &dependency, const std::string &dependencyName) const
	Returns a cached dependency after validating it exists and is initialized.
Protected Member Functions inherited from Ship::Part
virtual void	OnAdded (bool forced)
	Called after this Part has been added to a PartList.
virtual void	OnRemoved (bool forced)
	Called after this Part has been removed from a PartList.

Detailed Description

Component wrapper around a BS::thread_pool.

ThreadPool manages a thread pool within the component system, providing convenience methods for pausing and resuming pool execution.

Required Context children: None — ThreadPool has no dependencies on other components.

Obtain the instance from Context::GetChildren().GetFirst<ThreadPool>().

Constructor & Destructor Documentation

ThreadPool()

Ship::ThreadPool::ThreadPool ( size_t  threadCount )

explicit

Constructs a ThreadPool with the given number of worker threads.

Parameters

threadCount

The number of threads in the pool.

~ThreadPool()

Ship::ThreadPool::~ThreadPool ( )

overridedefault

Member Function Documentation

Get()

std::shared_ptr< BS::thread_pool > Ship::ThreadPool::Get

(

)

const

Returns the underlying thread pool.

Returns

A shared pointer to the BS::thread_pool.

Pause()

void Ship::ThreadPool::Pause

(

)

Pauses the thread pool, preventing it from picking up new tasks.

Unpause()

void Ship::ThreadPool::Unpause

(

)

Unpauses the thread pool, allowing it to resume picking up tasks.

---

The documentation for this class was generated from the following file:

• include/ship/thread/ThreadPool.h