job_init_token.hpp

Go to the documentation of this file.

/******************************************************************************/
/******************************************************************************/
#ifndef JOB_INITALIZATION_TOKEN_HPP
#define JOB_INITALIZATION_TOKEN_HPP
 
namespace Job
{
  struct JobSystemMemoryRequirements;
  struct InitializationToken;
 
  InitializationToken Initialize(const JobSystemMemoryRequirements& memory_requirements, void* const memory) noexcept;
 
  struct InitializationToken
  {
    unsigned int num_workers_created;
 
   private:
    InitializationToken(const unsigned int num_workers_created) :
      num_workers_created{num_workers_created}
    {
    }
 
    friend InitializationToken Initialize(const JobSystemMemoryRequirements& memory_requirements, void* const memory) noexcept;
  };
}  // namespace Job
 
#endif  // JOB_INITALIZATION_TOKEN_HPP
 
/******************************************************************************/
/*
  MIT License
 
  Copyright (c) 2023-2024 Shareef Abdoul-Raheem
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
/******************************************************************************/