Job::InitializationToken Struct Reference

#include <job_init_token.hpp>

Public Attributes
unsigned int	num_workers_created

Private Member Functions
	InitializationToken (const unsigned int num_workers_created)

Friends
InitializationToken	Initialize (const JobSystemMemoryRequirements &memory_requirements, void *const memory) noexcept
	Sets up the Job system and creates all the worker threads. The thread that calls 'Job::Initialize' is considered the main thread. More...

Detailed Description

Definition at line 22 of file job_init_token.hpp.

Constructor & Destructor Documentation

InitializationToken()

Job::InitializationToken::InitializationToken ( const unsigned int  num_workers_created )

inlineprivate

Definition at line 27 of file job_init_token.hpp.

                                                                :
      num_workers_created{num_workers_created}
    {
    }

Friends And Related Function Documentation

Initialize

InitializationToken Initialize ( const JobSystemMemoryRequirements &  memory_requirements, void *const  memory  )

friend

Sets up the Job system and creates all the worker threads. The thread that calls 'Job::Initialize' is considered the main thread.

Parameters

memory_requirements	The customization parameters to initialize the system with. To be gotten from Job::MemRequirementsForConfig.
memory	Must be memory_requirements.byte_size in size and with alignment memory_requirements.alignment. If nullptr then the system heap will be used.

Returns

The InitializationToken can be used by other subsystem to verify that the Job System has been initialized.

Member Data Documentation

num_workers_created

unsigned int Job::InitializationToken::num_workers_created

Definition at line 24 of file job_init_token.hpp.

---

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

• include/concurrent/job_init_token.hpp