/share/man/man3/pthread_cond_timedwait.3

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 101 lines · 101 code · 0 blank · 0 comment · 0 complexity · cccb7b5a660f8a369fcc461aeb1d6dd8 MD5 · raw file 

    

  1. .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
    2. 

  2. .\" All rights reserved.
    3. 

  3. .\"
    4. 

  4. .\" Redistribution and use in source and binary forms, with or without
    5. 

  5. .\" modification, are permitted provided that the following conditions
    6. 

  6. .\" are met:
    7. 

  7. .\" 1. Redistributions of source code must retain the above copyright
    8. 

  8. .\"    notice, this list of conditions and the following disclaimer.
    9. 

  9. .\" 2. Redistributions in binary form must reproduce the above copyright
    10. 

  10. .\"    notice, this list of conditions and the following disclaimer in the
    11. 

  11. .\"    documentation and/or other materials provided with the distribution.
    12. 

  12. .\" 3. Neither the name of the author nor the names of any co-contributors
    13. 

  13. .\"    may be used to endorse or promote products derived from this software
    14. 

  14. .\"    without specific prior written permission.
    15. 

  15. .\"
    16. 

  16. .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
    17. 

  17. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    18. 

  18. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    19. 

  19. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    20. 

  20. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    21. 

  21. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    22. 

  22. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    23. 

  23. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    24. 

  24. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    25. 

  25. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    26. 

  26. .\" SUCH DAMAGE.
    27. 

  27. .\"
    28. 

  28. .\" $FreeBSD$
    29. 

  29. .\"
    30. 

  30. .Dd May 9, 2010
    31. 

  31. .Dt PTHREAD_COND_TIMEDWAIT 3
    32. 

  32. .Os
    33. 

  33. .Sh NAME
    34. 

  34. .Nm pthread_cond_timedwait
    35. 

  35. .Nd "wait on a condition variable for a specific amount of time"
    36. 

  36. .Sh LIBRARY
    37. 

  37. .Lb libpthread
    38. 

  38. .Sh SYNOPSIS
    39. 

  39. .In pthread.h
    40. 

  40. .Ft int
    41. 

  41. .Fn pthread_cond_timedwait "pthread_cond_t *cond" "pthread_mutex_t *mutex" "const struct timespec *abstime"
    42. 

  42. .Sh DESCRIPTION
    43. 

  43. The
    44. 

  44. .Fn pthread_cond_timedwait
    45. 

  45. function atomically blocks the current thread waiting on the condition
    46. 

  46. variable specified by
    47. 

  47. .Fa cond ,
    48. 

  48. and releases the mutex specified by
    49. 

  49. .Fa mutex .
    50. 

  50. The waiting thread unblocks only after another thread calls
    51. 

  51. .Xr pthread_cond_signal 3 ,
    52. 

  52. or
    53. 

  53. .Xr pthread_cond_broadcast 3
    54. 

  54. with the same condition variable, or if the system time reaches the
    55. 

  55. time specified in
    56. 

  56. .Fa abstime ,
    57. 

  57. and the current thread reacquires the lock on
    58. 

  58. .Fa mutex .
    59. 

  59. .Pp
    60. 

  60. The clock used to measure
    61. 

  61. .Fa abstime
    62. 

  62. can be specified during creation of the condition variable using
    63. 

  63. .Xr pthread_condattr_setclock 3 .
    64. 

  64. .Sh RETURN VALUES
    65. 

  65. If successful, the
    66. 

  66. .Fn pthread_cond_timedwait
    67. 

  67. function will return zero.
    68. 

  68. Otherwise an error number will be returned to
    69. 

  69. indicate the error.
    70. 

  70. .Sh ERRORS
    71. 

  71. The
    72. 

  72. .Fn pthread_cond_timedwait
    73. 

  73. function will fail if:
    74. 

  74. .Bl -tag -width Er
    75. 

  75. .It Bq Er EINVAL
    76. 

  76. The value specified by
    77. 

  77. .Fa cond ,
    78. 

  78. .Fa mutex
    79. 

  79. or
    80. 

  80. .Fa abstime
    81. 

  81. is invalid.
    82. 

  82. .It Bq Er ETIMEDOUT
    83. 

  83. The system time has reached or exceeded the time specified in
    84. 

  84. .Fa abstime .
    85. 

  85. .It Bq Er EPERM
    86. 

  86. The specified
    87. 

  87. .Fa mutex
    88. 

  88. was not locked by the calling thread.
    89. 

  89. .El
    90. 

  90. .Sh SEE ALSO
    91. 

  91. .Xr pthread_cond_broadcast 3 ,
    92. 

  92. .Xr pthread_cond_destroy 3 ,
    93. 

  93. .Xr pthread_cond_init 3 ,
    94. 

  94. .Xr pthread_cond_signal 3 ,
    95. 

  95. .Xr pthread_cond_wait 3 ,
    96. 

  96. .Xr pthread_condattr_setclock 3
    97. 

  97. .Sh STANDARDS
    98. 

  98. The
    99. 

  99. .Fn pthread_cond_timedwait
    100. 

  100. function conforms to
    101. 

  101. .St -p1003.1-96 .
    102.