.\" Copyright (c) 1998 Alex Nash
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" %FreeBSD: src/lib/libc_r/man/pthread_rwlock_wrlock.3,v 1.2.2.2 2001/12/17 10:08:26 ru Exp %
.\"
.\" $FreeBSD$
.Dd August 4, 1998
.Dt PTHREAD_RWLOCK_WRLOCK 3
.Os
.Sh 名称
.Nm pthread_rwlock_wrlock ,
.Nm pthread_rwlock_trywrlock
.Nd 書込み用の読取り / 書込みロックの獲得
.Sh ライブラリ
.Lb libc_r
.Sh 書式
.In pthread.h
.Ft int
.Fn pthread_rwlock_wrlock "pthread_rwlock_t *lock"
.Ft int
.Fn pthread_rwlock_trywrlock "pthread_rwlock_t *lock"
.Sh 解説
.Fn pthread_rwlock_wrlock
関数は、
.Fa lock
に対して書込み用のロックを獲得できるまで、ブロックします。
.Fn pthread_rwlock_trywrlock
関数は、同じ操作を実行しますが、すぐにロックを獲得できない場合には、
ブロックしません。
.Pp
呼び出しているスレッドが、呼び出しが行なわれたのと同時に既にそのロックを
保持している場合には、その結果は未定義です。
.Sh 実装に関する注
書込み側の飢餓状態を防ぐため、書込み側が読込み側よりも優先されます。
.Sh 戻り値
問題がない場合は、
.Fn pthread_rwlock_wrlock
および
.Fn pthread_rwlock_trywrlock
関数は 0 を返します。
問題がある場合は、そのエラーを示すためにエラー番号が返されます。
.Sh 関連項目
.Xr pthread_rwlock_trywrlock 3 ,
.Xr pthread_rwlock_unlock 3 ,
.Xr pthread_rwlock_wrlock 3
.Sh 規格
.Fn pthread_rwlock_wrlock
および
.Fn pthread_rwlock_trywrlock
関数は、
.St -susv2
に適合しているはずです。
.Sh エラー
.Fn pthread_rwlock_trywrlock
関数は、以下の場合に失敗します。
.Bl -tag -width Er
.It Bq Er EBUSY
呼び出しているスレッドがブロック無しでロックを獲得できません。
.El
.Pp
.Fn pthread_rwlock_wrlock
および
.Fn pthread_rwlock_trywrlock
関数は、以下の場合に失敗することがあります。
.Bl -tag -width Er
.It Bq Er EDEADLK
呼び出しているスレッドが既にその読取り / 書込みロックを (読取り用または
書込み用に) 所有しています。
.It Bq Er EINVAL
.Fa lock
によって指定された値が無効です。
.It Bq Er ENOMEM
ロック (静的に初期化されたロックのみに適用) の初期化のために
十分なメモリがありません
.El
.Sh 歴史
.Fn pthread_rwlock_wrlock
関数は、
.Fx 3.0
ではじめて登場しました。