lib/libpthread/sem_wait.3

   1 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/lib/libc_r/man/sem_wait.3,v 1.1.2.7 2001/12/17 10:08:26 ru Exp $
  29 .\" $DragonFly: src/lib/libc_r/man/sem_wait.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  30 .Dd April 15, 2009
  31 .Dt SEM_WAIT 3
  32 .Os
  33 .Sh NAME
  34 .Nm sem_wait ,
  35 .Nm sem_trywait
  36 .Nd decrement (lock) a semaphore
  37 .Sh LIBRARY
  38 .Lb libpthread
  39 .Sh SYNOPSIS
  40 .In semaphore.h
  41 .Ft int
  42 .Fn sem_wait "sem_t *sem"
  43 .Ft int
  44 .Fn sem_trywait "sem_t *sem"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn sem_wait
  48 function decrements (locks) the semaphore pointed to by
  49 .Fa sem ,
  50 but blocks if the value of
  51 .Fa sem
  52 is zero, until the value is non-zero and the value can be decremented.
  53 .Pp
  54 The
  55 .Fn sem_trywait
  56 function decrements (locks) the semaphore pointed to by
  57 .Fa sem
  58 only if the value is non-zero.  Otherwise, the semaphore is not decremented and
  59 an error is returned.
  60 .Sh RETURN VALUES
  61 .Rv -std
  62 .Sh ERRORS
  63 .Fn sem_wait
  64 and
  65 .Fn sem_trywait
  66 will fail if:
  67 .Bl -tag -width Er
  68 .It Bq Er EINVAL
  69 .Fa sem
  70 points to an invalid semaphore.
  71 .El
  72 .Pp
  73 Additionally,
  74 .Fn sem_trywait
  75 will fail if:
  76 .Bl -tag -width Er
  77 .It Bq Er EAGAIN
  78 The semaphore value was zero, and thus could not be decremented.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr sem_post 3
  82 .Sh STANDARDS
  83 .Fn sem_wait
  84 and
  85 .Fn sem_trywait
  86 conform to
  87 .St -p1003.1-96 .