124 lines
5.0 KiB
Groff
124 lines
5.0 KiB
Groff
.\" $NetBSD: pthread_getspecific.3,v 1.5 2010/07/09 10:49:48 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c) 2002, 2010 The NetBSD Foundation, Inc.
|
|
.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
|
|
.\"
|
|
.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
|
|
.\" 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.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by John Birrell.
|
|
.\" 4. Neither the name of the author nor the names of any co-contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL 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 REGENTS 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/libpthread/man/pthread_getspecific.3,v 1.11 2002/09/16 19:29:28 mini Exp $
|
|
.\"
|
|
.Dd July 9, 2010
|
|
.Dt PTHREAD_GETSPECIFIC 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm pthread_getspecific
|
|
.Nd thread-specific data value
|
|
.Sh LIBRARY
|
|
.Lb libpthread
|
|
.Sh SYNOPSIS
|
|
.In pthread.h
|
|
.Ft void *
|
|
.Fn pthread_getspecific "pthread_key_t key"
|
|
.Ft int
|
|
.Fn pthread_setspecific "pthread_key_t key" "const void *value"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn pthread_getspecific
|
|
function returns the value currently bound to the specified
|
|
.Fa key
|
|
on behalf of the calling thread.
|
|
Conversely, the
|
|
.Fn pthread_setspecific
|
|
function associates a thread-specific value with a
|
|
.Fa key
|
|
obtained via a previous call to
|
|
.Xr pthread_key_create 3 .
|
|
Different threads have different values bound to each key.
|
|
These values are typically pointers to blocks of dynamically
|
|
allocated memory that have been reserved for use by the calling thread.
|
|
.Pp
|
|
Undefined behavior may follow if either function is called with a
|
|
.Fa key
|
|
value not obtained from
|
|
.Xr pthread_key_create 3 ,
|
|
or if the call is made after
|
|
.Fa key
|
|
has been deleted with
|
|
.Xr pthread_key_delete 3 .
|
|
It is possible to call either function from
|
|
a thread-specific data destructor function.
|
|
Note however that this is not well defined for the
|
|
.Fn pthread_setspecific
|
|
function;
|
|
lost storage or infinite loops may occur.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn pthread_getspecific
|
|
function will return the thread-specific data value associated with the given
|
|
.Fa key .
|
|
If no thread-specific data value is associated with
|
|
.Fa key ,
|
|
then the value
|
|
.Dv NULL
|
|
is returned.
|
|
If successful, the
|
|
.Fn pthread_setspecific
|
|
function will return zero.
|
|
Otherwise an error number will be returned to
|
|
indicate the error.
|
|
.Sh ERRORS
|
|
No errors are defined for either function.
|
|
.Sh SEE ALSO
|
|
.Xr pthread_key_create 3
|
|
.Sh STANDARDS
|
|
These functions conform to
|
|
.St -p1003.1-2001 .
|