SDL_mutex.h
上传用户:sun1608
上传日期:2007-02-02
资源大小:6116k
文件大小:6k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

Visual C++

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