lib/libpthread/pthread_barrier_destroy.3

   1 .\" $NetBSD: pthread_barrier_destroy.3,v 1.6 2008/04/30 13:10:52 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .Dd January 30, 2003
  26 .Dt PTHREAD_BARRIER_DESTROY 3
  27 .Os
  28 .Sh NAME
  29 .Nm pthread_barrier_destroy
  30 .Nd destroy a barrier
  31 .Sh LIBRARY
  32 .Lb libpthread
  33 .Sh SYNOPSIS
  34 .In pthread.h
  35 .Ft int
  36 .Fn pthread_barrier_destroy "pthread_barrier_t *barrier"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn pthread_barrier_destroy
  40 function causes the resources allocated to
  41 .Fa barrier
  42 to be released.
  43 No threads should be blocked on
  44 .Fa barrier .
  45 .Sh RETURN VALUES
  46 If successful,
  47 .Fn pthread_barrier_destroy
  48 will return zero.
  49 Otherwise an error value will be returned.
  50 .Sh ERRORS
  51 .Fn pthread_barrier_destroy
  52 may fail if:
  53 .Bl -tag -width Er
  54 .It Bq Er EBUSY
  55 The
  56 .Fa barrier
  57 still has active threads associated with it.
  58 .It Bq Er EINVAL
  59 The value specified by
  60 .Fa barrier
  61 is invalid.
  62 .El
  63 .Sh SEE ALSO
  64 .Xr pthread_barrier_init 3 ,
  65 .Xr pthread_barrier_wait 3 ,
  66 .Xr pthread_barrierattr_destroy 3 ,
  67 .Xr pthread_barrierattr_init 3
  68 .Sh STANDARDS
  69 .Fn pthread_barrier_destroy
  70 conforms to
  71 .St -p1003.1-2001 .