xref: /freebsd/share/man/man3/pthread_rwlock_unlock.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1c0e36632SAlexander Langer.\" Copyright (c) 1998 Alex Nash
2c0e36632SAlexander Langer.\" All rights reserved.
3c0e36632SAlexander Langer.\"
4c0e36632SAlexander Langer.\" Redistribution and use in source and binary forms, with or without
5c0e36632SAlexander Langer.\" modification, are permitted provided that the following conditions
6c0e36632SAlexander Langer.\" are met:
7c0e36632SAlexander Langer.\" 1. Redistributions of source code must retain the above copyright
8c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer.
9c0e36632SAlexander Langer.\" 2. Redistributions in binary form must reproduce the above copyright
10c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer in the
11c0e36632SAlexander Langer.\"    documentation and/or other materials provided with the distribution.
12c0e36632SAlexander Langer.\"
13c0e36632SAlexander Langer.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14c0e36632SAlexander Langer.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15c0e36632SAlexander Langer.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16c0e36632SAlexander Langer.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17c0e36632SAlexander Langer.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18c0e36632SAlexander Langer.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19c0e36632SAlexander Langer.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20c0e36632SAlexander Langer.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21c0e36632SAlexander Langer.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22c0e36632SAlexander Langer.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23c0e36632SAlexander Langer.\" SUCH DAMAGE.
24c0e36632SAlexander Langer.\"
25c0e36632SAlexander Langer.Dd August 4, 1998
26c0e36632SAlexander Langer.Dt PTHREAD_RWLOCK_UNLOCK 3
27c0e36632SAlexander Langer.Os
28c0e36632SAlexander Langer.Sh NAME
29c0e36632SAlexander Langer.Nm pthread_rwlock_unlock
30c0e36632SAlexander Langer.Nd release a read/write lock
31d8a78688SAlexey Zelkin.Sh LIBRARY
32ec7452f1SRuslan Ermilov.Lb libpthread
33c0e36632SAlexander Langer.Sh SYNOPSIS
3432eef9aeSRuslan Ermilov.In pthread.h
35c0e36632SAlexander Langer.Ft int
36c0e36632SAlexander Langer.Fn pthread_rwlock_unlock "pthread_rwlock_t *lock"
37c0e36632SAlexander Langer.Sh DESCRIPTION
38c0e36632SAlexander LangerThe
39c0e36632SAlexander Langer.Fn pthread_rwlock_unlock
40c0e36632SAlexander Langerfunction is used to release the read/write lock previously obtained by
41c0e36632SAlexander Langer.Fn pthread_rwlock_rdlock ,
42c0e36632SAlexander Langer.Fn pthread_rwlock_wrlock ,
43c0e36632SAlexander Langer.Fn pthread_rwlock_tryrdlock ,
44c0e36632SAlexander Langeror
45c0e36632SAlexander Langer.Fn pthread_rwlock_trywrlock .
46c0e36632SAlexander Langer.Sh RETURN VALUES
47c0e36632SAlexander LangerIf successful, the
48c0e36632SAlexander Langer.Fn pthread_rwlock_unlock
495203edcdSRuslan Ermilovfunction will return zero.
505203edcdSRuslan ErmilovOtherwise an error number will be returned
51c0e36632SAlexander Langerto indicate the error.
52c0e36632SAlexander Langer.Pp
53c0e36632SAlexander LangerThe results are undefined if
54c0e36632SAlexander Langer.Fa lock
55c0e36632SAlexander Langeris not held by the calling thread.
56c0e36632SAlexander Langer.Sh ERRORS
57c0e36632SAlexander LangerThe
58c0e36632SAlexander Langer.Fn pthread_rwlock_unlock
59c0e36632SAlexander Langerfunction may fail if:
60c0e36632SAlexander Langer.Bl -tag -width Er
61c0e36632SAlexander Langer.It Bq Er EINVAL
62c0e36632SAlexander LangerThe value specified by
63c0e36632SAlexander Langer.Fa lock
64c0e36632SAlexander Langeris invalid.
65c0e36632SAlexander Langer.It Bq Er EPERM
66c0e36632SAlexander LangerThe current thread does not own the read/write lock.
67c0e36632SAlexander Langer.El
689cbda590SRuslan Ermilov.Sh SEE ALSO
699cbda590SRuslan Ermilov.Xr pthread_rwlock_rdlock 3 ,
709cbda590SRuslan Ermilov.Xr pthread_rwlock_wrlock 3
719cbda590SRuslan Ermilov.Sh STANDARDS
729cbda590SRuslan ErmilovThe
739cbda590SRuslan Ermilov.Fn pthread_rwlock_unlock
749cbda590SRuslan Ermilovfunction is expected to conform to
759cbda590SRuslan Ermilov.St -susv2 .
76c0e36632SAlexander Langer.Sh HISTORY
77c0e36632SAlexander LangerThe
78c0e36632SAlexander Langer.Fn pthread_rwlock_unlock
79c0e36632SAlexander Langerfunction first appeared in
80c0e36632SAlexander Langer.Fx 3.0 .
81