lib/libpthread/pthread_condattr.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/share/man/man3/pthread_condattr.3,v 1.15 2007/10/22 10:08:00 ru Exp $
  29 .\" $DragonFly: src/lib/libc_r/man/pthread_condattr.3,v 1.3 2004/03/11 12:28:51 hmp Exp $
  30 .Dd July 10, 2009
  31 .Dt PTHREAD_CONDATTR 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_condattr_init ,
  35 .Nm pthread_condattr_destroy
  36 .Nd condition attribute operations
  37 .Sh LIBRARY
  38 .Lb libpthread
  39 .Sh SYNOPSIS
  40 .In pthread.h
  41 .Ft int
  42 .Fn pthread_condattr_init "pthread_condattr_t *attr"
  43 .Ft int
  44 .Fn pthread_condattr_destroy "pthread_condattr_t *attr"
  45 .Sh DESCRIPTION
  46 Condition attribute objects are used to specify parameters to
  47 .Fn pthread_cond_init .
  48 .Dx Ns 's
  49 implementation of conditions does not support any non-default
  50 attributes, so these functions are not very useful, though they are required
  51 to be present by
  52 .Tn POSIX .
  53 .Pp
  54 The
  55 .Fn pthread_condattr_init
  56 function initializes a condition attribute object with the default attributes.
  57 .Pp
  58 The
  59 .Fn pthread_condattr_destroy
  60 function destroys a condition attribute object.
  61 .Sh RETURN VALUES
  62 If successful, these functions return 0.
  63 Otherwise, an error number is returned to indicate the error.
  64 .Sh ERRORS
  65 The
  66 .Fn pthread_condattr_init
  67 function will fail if:
  68 .Bl -tag -width Er
  69 .It Bq Er ENOMEM
  70 Out of memory.
  71 .El
  72 .Pp
  73 The
  74 .Fn pthread_condattr_destroy
  75 function will fail if:
  76 .Bl -tag -width Er
  77 .It Bq Er EINVAL
  78 Invalid value for
  79 .Fa attr .
  80 .El
  81 .Sh SEE ALSO
  82 .Xr pthread_cond_init 3
  83 .Sh STANDARDS
  84 The
  85 .Fn pthread_condattr_init
  86 and
  87 .Fn pthread_condattr_destroy
  88 functions conform to
  89 .St -p1003.1-96 .