2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* thread.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 14:16:55 +02:00
/* https://godotengine.org */
2014-02-10 02:10:30 +01:00
/*************************************************************************/
2019-01-03 11:41:35 +01:00
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
2014-02-10 02:10:30 +01:00
/* */
/* 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. */
/*************************************************************************/
2018-01-05 00:50:27 +01:00
2014-02-10 02:10:30 +01:00
# ifndef THREAD_H
# define THREAD_H
# include "typedefs.h"
/**
@ author Juan Linietsky < reduzio @ gmail . com >
*/
2015-12-17 10:24:27 +01:00
# include "ustring.h"
2014-02-10 02:10:30 +01:00
typedef void ( * ThreadCreateCallback ) ( void * p_userdata ) ;
class Thread {
public :
enum Priority {
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
PRIORITY_LOW ,
2017-03-05 16:44:50 +01:00
PRIORITY_NORMAL ,
2014-02-10 02:10:30 +01:00
PRIORITY_HIGH
} ;
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
struct Settings {
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
Priority priority ;
2017-03-05 16:44:50 +01:00
Settings ( ) { priority = PRIORITY_NORMAL ; }
2014-02-10 02:10:30 +01:00
} ;
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
typedef uint64_t ID ;
2016-03-09 00:00:52 +01:00
protected :
2017-03-05 16:44:50 +01:00
static Thread * ( * create_func ) ( ThreadCreateCallback p_callback , void * , const Settings & ) ;
2017-08-07 12:17:31 +02:00
static ID ( * get_thread_id_func ) ( ) ;
2017-03-05 16:44:50 +01:00
static void ( * wait_to_finish_func ) ( Thread * ) ;
static Error ( * set_name_func ) ( const String & ) ;
2014-02-10 02:10:30 +01:00
2016-06-25 15:40:33 +02:00
friend class Main ;
2014-02-10 02:10:30 +01:00
2016-06-25 15:40:33 +02:00
static ID _main_thread_id ;
2014-02-10 02:10:30 +01:00
Thread ( ) ;
2016-03-09 00:00:52 +01:00
2017-03-05 16:44:50 +01:00
public :
2017-08-07 12:17:31 +02:00
virtual ID get_id ( ) const = 0 ;
2016-02-01 00:22:38 +01:00
static Error set_name ( const String & p_name ) ;
2017-08-07 12:17:31 +02:00
_FORCE_INLINE_ static ID get_main_id ( ) { return _main_thread_id ; } ///< get the ID of the main thread
static ID get_caller_id ( ) ; ///< get the ID of the caller function ID
2014-02-10 02:10:30 +01:00
static void wait_to_finish ( Thread * p_thread ) ; ///< waits until thread is finished, and deallocates it.
2017-03-05 16:44:50 +01:00
static Thread * create ( ThreadCreateCallback p_callback , void * p_user , const Settings & p_settings = Settings ( ) ) ; ///< Static function to create a thread, will call p_callback
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
virtual ~ Thread ( ) ;
} ;
# endif