pthreads/pthread_mutex_trylock.3

   1 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
   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, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the author nor the names of any co-contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/lib/libc_r/man/pthread_mutex_trylock.3,v 1.5.2.4 2001/08/17 15:42:51 ru Exp $
  29 .\"
  30 .Dd July 30, 1998
  31 .Dt PTHREAD_MUTEX_TRYLOCK 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_mutex_trylock
  35 .Nd attempt to lock a mutex without blocking
  36 .Sh SYNOPSIS
  37 .Fd #include <pthread.h>
  38 .Ft int
  39 .Fo pthread_mutex_trylock
  40 .Fa "pthread_mutex_t *mutex"
  41 .Fc
  42 .Sh DESCRIPTION
  43 The
  44 .Fn pthread_mutex_trylock
  45 function locks
  46 .Fa mutex .
  47 If the mutex is already locked,
  48 .Fn pthread_mutex_trylock
  49 will not block waiting for the mutex, but will return an error condition.
  50 .Sh RETURN VALUES
  51 If successful,
  52 .Fn pthread_mutex_trylock
  53 will return zero.
  54 Otherwise, an error number will be returned to indicate the error.
  55 .Sh ERRORS
  56 .Fn pthread_mutex_trylock
  57 will fail if:
  58 .Bl -tag -width Er
  59 .It Bq Er EBUSY
  60 .Fa Mutex
  61 is already locked.
  62 .It Bq Er EINVAL
  63 The value specified by
  64 .Fa mutex
  65 is invalid.
  66 .El
  67 .Sh SEE ALSO
  68 .Xr pthread_mutex_destroy 3 ,
  69 .Xr pthread_mutex_init 3 ,
  70 .Xr pthread_mutex_lock 3 ,
  71 .Xr pthread_mutex_unlock 3
  72 .Sh STANDARDS
  73 .Fn pthread_mutex_trylock
  74 conforms to
  75 .St -p1003.1-96 .