.TH "Thread-Specific Storage" 3 "Tue Nov 27 2012" "Version 14.7" "globus common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Thread-Specific Storage \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBglobus_thread_key_create\fP (\fBglobus_thread_key_t\fP *key, \fBglobus_thread_key_destructor_func_t\fP destructor)"
.br
.ti -1c
.RI "int \fBglobus_thread_key_delete\fP (\fBglobus_thread_key_t\fP key)"
.br
.ti -1c
.RI "void * \fBglobus_thread_getspecific\fP (\fBglobus_thread_key_t\fP key)"
.br
.ti -1c
.RI "int \fBglobus_thread_setspecific\fP (\fBglobus_thread_key_t\fP key, void *value)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBglobus_thread_key_t\fP data type acts as a key to thread-specific storage\&. For each key created by \fBglobus_thread_key_create()\fP, each thread may store and retrieve its own value\&. 
.SH "Function Documentation"
.PP 
.SS "int globus_thread_key_create (\fBglobus_thread_key_t\fP *key, \fBglobus_thread_key_destructor_func_t\fPdestructor)"

.PP
Create a key for thread-specific storage\&. .PP
.nf
The globus_thread_key_create() function creates a new key for
thread-specific data. The new key will be available for all threads
to store a distinct value. If the function pointer @a destructor
is non-NULL, then that function will be invoked when a thread exits
that has a non-NULL value associated with the key.
.fi
.PP
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP Pointer to be set to the new key\&. 
.br
\fIdestructor\fP Pointer to a function to call when a thread exits to free the key's value\&.
.RE
.PP
\fBReturns:\fP
.RS 4
On success, globus_thread_create_key() will create a new key to thread-local storage and return GLOBUS_SUCCESS\&. If an error occurs, then the value of \fIkey\fP is undefined and globus_thread_create_key() returns an implementation-specific non-zero error value\&. 
.RE
.PP

.SS "int globus_thread_key_delete (\fBglobus_thread_key_t\fPkey)"

.PP
Delete a thread-local storage key\&. .PP
.nf
The globus_thread_key_delete() function deletes the key used for a 
thread-local storage association. The destructor function for this
key will no longer be called after this function returns. The behavior
of subsequent calls to globus_thread_getspecific() or
globus_thread_setspecific() with this key will be undefined.
.fi
.PP
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP Key to destroy\&.
.RE
.PP
\fBReturns:\fP
.RS 4
On success, \fBglobus_thread_key_delete()\fP will delete a thread-local storage key and return GLOBUS_SUCCESS\&. If an error occurs, then the value of \fIkey\fP is undefined and globus_thread_create_key() returns an implementation-specific non-zero error value\&. 
.RE
.PP

.SS "void* globus_thread_getspecific (\fBglobus_thread_key_t\fPkey)"

.PP
Get a thread-specific data value\&. .PP
.nf
The globus_thread_getspecific() function returns the value associated
with the thread-specific data key passed as its first parameter. This
function returns NULL if the value has not been set by the current
thread. The return value is undefined if the key is not valid.
.fi
.PP
 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP Thread-specific data key to look up\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
The value passed to a previous call to \fBglobus_thread_setspecific()\fP in the current thread for this key\&. 
.RE
.PP

.SS "int globus_thread_setspecific (\fBglobus_thread_key_t\fPkey, void *value)"

.PP
Set a thread-specific data value\&. .PP
.nf
The globus_thread_setspecific() function associates a thread-specific
value with a data key. If the key had a previous value set in the
current thread, it is replaced, but the destructor function is not
called for the old value.
.fi
.PP
 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP Thread-specific data key to store\&. 
.br
\fIvalue\fP A pointer to data to store as the thread-specific data for this thread\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
On success, \fBglobus_thread_setspecific()\fP stores value in the thread-specific data for the specified key and returns GLOBUS_SUCCESS\&. If an error occurs, \fBglobus_thread_setspecific()\fP returns an implementation-specific non-zero error code and does not modify the key's value for this thread\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus common from the source code\&.