KSThread.h 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. //
  2. // KSThread.h
  3. //
  4. // Created by Karl Stenerud on 2012-01-29.
  5. //
  6. // Copyright (c) 2012 Karl Stenerud. All rights reserved.
  7. //
  8. // Permission is hereby granted, free of charge, to any person obtaining a copy
  9. // of this software and associated documentation files (the "Software"), to deal
  10. // in the Software without restriction, including without limitation the rights
  11. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. // copies of the Software, and to permit persons to whom the Software is
  13. // furnished to do so, subject to the following conditions:
  14. //
  15. // The above copyright notice and this permission notice shall remain in place
  16. // in this source code.
  17. //
  18. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. // THE SOFTWARE.
  25. //
  26. #ifndef HDR_KSThread_h
  27. #define HDR_KSThread_h
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif
  31. #include <sys/types.h>
  32. #include <stdbool.h>
  33. typedef uintptr_t KSThread;
  34. /** Get a thread's name. Internally, a thread name will
  35. * never be more than 64 characters long.
  36. *
  37. * @param thread The thread whose name to get.
  38. *
  39. * @oaram buffer Buffer to hold the name.
  40. *
  41. * @param bufLength The length of the buffer.
  42. *
  43. * @return true if a name was found.
  44. */
  45. bool ksthread_getThreadName(const KSThread thread, char* const buffer, int bufLength);
  46. /** Get the name of a thread's dispatch queue. Internally, a queue name will
  47. * never be more than 64 characters long.
  48. *
  49. * @param thread The thread whose queue name to get.
  50. *
  51. * @oaram buffer Buffer to hold the name.
  52. *
  53. * @param bufLength The length of the buffer.
  54. *
  55. * @return true if a name or label was found.
  56. */
  57. bool ksthread_getQueueName(KSThread thread, char* buffer, int bufLength);
  58. /* Get the current mach thread ID.
  59. * mach_thread_self() receives a send right for the thread port which needs to
  60. * be deallocated to balance the reference count. This function takes care of
  61. * all of that for you.
  62. *
  63. * @return The current thread ID.
  64. */
  65. KSThread ksthread_self(void);
  66. #ifdef __cplusplus
  67. }
  68. #endif
  69. #endif // HDR_KSThread_h