File: thread_pool.h

package info (click to toggle)
kicad 9.0.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 788,516 kB
  • sloc: cpp: 976,024; ansic: 121,001; xml: 66,428; python: 18,419; sh: 1,010; awk: 301; asm: 292; makefile: 228; javascript: 167; perl: 10
file content (52 lines) | stat: -rw-r--r-- 1,909 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see CHANGELOG.TXT for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#pragma once
#ifndef INCLUDE_THREAD_POOL_H_
#define INCLUDE_THREAD_POOL_H_

#include <bs_thread_pool.hpp>
#include <import_export.h>

using thread_pool = BS::thread_pool;

/**
 * Get a reference to the current thread pool.  N.B., you cannot copy the thread pool
 * so if you accidentally write thread_pool tp = GetKiCadThreadPool(), you will break
 * your compilation
 *
 * @return Reference to the current (potentially newly constructed) thread pool
 */
APIEXPORT thread_pool& GetKiCadThreadPool();

/**
 * Invalidate the cached thread pool pointer.
 *
 * This must be called after the thread pool owned by PGM_BASE is destroyed
 * (via KICAD_SINGLETON::Shutdown()) to prevent dangling pointer access.
 * Any subsequent calls to GetKiCadThreadPool() will re-initialize the cache.
 */
APIEXPORT void InvalidateKiCadThreadPool();


#endif /* INCLUDE_THREAD_POOL_H_ */