home *** CD-ROM | disk | FTP | other *** search
/ GameStar Special 2004 August / GSSH0804.iso / Action / Parsec47 / Parsec47.exe / p47 / import / SDL_mutex.d < prev    next >
Text File  |  2003-11-29  |  5KB  |  135 lines
  1. /*
  2.     SDL - Simple DirectMedia Layer
  3.     Copyright (C) 1997, 1998, 1999, 2000, 2001  Sam Lantinga
  4.  
  5.     This library is free software; you can redistribute it and/or
  6.     modify it under the terms of the GNU Library General Public
  7.     License as published by the Free Software Foundation; either
  8.     version 2 of the License, or (at your option) any later version.
  9.  
  10.     This library is distributed in the hope that it will be useful,
  11.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.     Library General Public License for more details.
  14.  
  15.     You should have received a copy of the GNU Library General Public
  16.     License along with this library; if not, write to the Free
  17.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18.  
  19.     Sam Lantinga
  20.     slouken@devolution.com
  21. */
  22.  
  23. /* Functions to provide thread synchronization primitives
  24.  
  25.     These are independent of the other SDL routines.
  26. */
  27.  
  28. import SDL_types;
  29.  
  30. extern(C):
  31.  
  32. /* Synchronization functions which can time out return this value
  33.    if they time out.
  34. */
  35. const uint SDL_MUTEX_TIMEDOUT    = 1;
  36.  
  37. /* This is the timeout value which corresponds to never time out */
  38. const uint SDL_MUTEX_MAXWAIT    = 0xFFFFFFFF;
  39.  
  40.  
  41. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  42. /* Mutex functions                                               */
  43. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  44. struct SDL_mutex { }
  45.  
  46. /* Create a mutex, initialized unlocked */
  47. SDL_mutex * SDL_CreateMutex();
  48.  
  49. /* Lock the mutex  (Returns 0, or -1 on error) */
  50. int SDL_LockMutex(SDL_mutex *m) { return SDL_mutexP(m); }
  51. int SDL_mutexP(SDL_mutex *mutex);
  52.  
  53. /* Unlock the mutex  (Returns 0, or -1 on error) */
  54. int SDL_UnlockMutex(SDL_mutex* m) { return SDL_mutexV(m); }
  55. int SDL_mutexV(SDL_mutex *mutex);
  56.  
  57. /* Destroy a mutex */
  58. void SDL_DestroyMutex(SDL_mutex *mutex);
  59.  
  60.  
  61. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  62. /* Semaphore functions                                           */
  63. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  64. struct SDL_sem { }
  65.  
  66. /* Create a semaphore, initialized with value, returns NULL on failure. */
  67. SDL_sem * SDL_CreateSemaphore(Uint32 initial_value);
  68.  
  69. /* Destroy a semaphore */
  70. void SDL_DestroySemaphore(SDL_sem *sem);
  71.  
  72. /* This function suspends the calling thread until the semaphore pointed 
  73.  * to by sem has a positive count. It then atomically decreases the semaphore
  74.  * count.
  75.  */
  76. int SDL_SemWait(SDL_sem *sem);
  77.  
  78. /* Non-blocking variant of SDL_SemWait(), returns 0 if the wait succeeds,
  79.    SDL_MUTEX_TIMEDOUT if the wait would block, and -1 on error.
  80. */
  81. int SDL_SemTryWait(SDL_sem *sem);
  82.  
  83. /* Variant of SDL_SemWait() with a timeout in milliseconds, returns 0 if
  84.    the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in
  85.    the allotted time, and -1 on error.
  86.    On some platforms this function is implemented by looping with a delay
  87.    of 1 ms, and so should be avoided if possible.
  88. */
  89. int SDL_SemWaitTimeout(SDL_sem *sem, Uint32 ms);
  90.  
  91. /* Atomically increases the semaphore's count (not blocking), returns 0,
  92.    or -1 on error.
  93.  */
  94. int SDL_SemPost(SDL_sem *sem);
  95.  
  96. /* Returns the current count of the semaphore */
  97. Uint32 SDL_SemValue(SDL_sem *sem);
  98.  
  99.  
  100. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  101. /* Condition variable functions                                  */
  102. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  103. struct SDL_cond { }
  104.  
  105. /* Create a condition variable */
  106. SDL_cond * SDL_CreateCond();
  107.  
  108. /* Destroy a condition variable */
  109. void SDL_DestroyCond(SDL_cond *cond);
  110.  
  111. /* Restart one of the threads that are waiting on the condition variable,
  112.    returns 0 or -1 on error.
  113.  */
  114. int SDL_CondSignal(SDL_cond *cond);
  115.  
  116. /* Restart all threads that are waiting on the condition variable,
  117.    returns 0 or -1 on error.
  118.  */
  119. int SDL_CondBroadcast(SDL_cond *cond);
  120.  
  121. /* Wait on the condition variable, unlocking the provided mutex.
  122.    The mutex must be locked before entering this function!
  123.    Returns 0 when it is signaled, or -1 on error.
  124.  */
  125. int SDL_CondWait(SDL_cond *cond, SDL_mutex *mut);
  126.  
  127. /* Waits for at most 'ms' milliseconds, and returns 0 if the condition
  128.    variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not
  129.    signaled in the allotted time, and -1 on error.
  130.    On some platforms this function is implemented by looping with a delay
  131.    of 1 ms, and so should be avoided if possible.
  132. */
  133. int SDL_CondWaitTimeout(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms);
  134.  
  135.