thread.h 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. /*************************************************************************/
  2. /* thread.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef THREAD_H
  31. #define THREAD_H
  32. #include "core/typedefs.h"
  33. #include "core/ustring.h"
  34. /**
  35. @author Juan Linietsky <reduzio@gmail.com>
  36. */
  37. typedef void (*ThreadCreateCallback)(void *p_userdata);
  38. class Thread {
  39. public:
  40. enum Priority {
  41. PRIORITY_LOW,
  42. PRIORITY_NORMAL,
  43. PRIORITY_HIGH
  44. };
  45. struct Settings {
  46. Priority priority;
  47. Settings() { priority = PRIORITY_NORMAL; }
  48. };
  49. typedef uint64_t ID;
  50. protected:
  51. static Thread *(*create_func)(ThreadCreateCallback p_callback, void *, const Settings &);
  52. static ID (*get_thread_id_func)();
  53. static void (*wait_to_finish_func)(Thread *);
  54. static Error (*set_name_func)(const String &);
  55. friend class Main;
  56. static ID _main_thread_id;
  57. Thread();
  58. public:
  59. virtual ID get_id() const = 0;
  60. static Error set_name(const String &p_name);
  61. _FORCE_INLINE_ static ID get_main_id() { return _main_thread_id; } ///< get the ID of the main thread
  62. static ID get_caller_id(); ///< get the ID of the caller function ID
  63. static void wait_to_finish(Thread *p_thread); ///< waits until thread is finished, and deallocates it.
  64. static Thread *create(ThreadCreateCallback p_callback, void *p_user, const Settings &p_settings = Settings()); ///< Static function to create a thread, will call p_callback
  65. virtual ~Thread();
  66. };
  67. #endif