/share/man/man3/pthread_setspecific.3

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 98 lines · 98 code · 0 blank · 0 comment · 0 complexity · cbd0bf5f9a65d32ae802516c70607d49 MD5 · raw file 

    

  1. .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
    2. 

  2. .\" All rights reserved.
    3. 

  3. .\"
    4. 

  4. .\" Redistribution and use in source and binary forms, with or without
    5. 

  5. .\" modification, are permitted provided that the following conditions
    6. 

  6. .\" are met:
    7. 

  7. .\" 1. Redistributions of source code must retain the above copyright
    8. 

  8. .\"    notice, this list of conditions and the following disclaimer.
    9. 

  9. .\" 2. Redistributions in binary form must reproduce the above copyright
    10. 

  10. .\"    notice, this list of conditions and the following disclaimer in the
    11. 

  11. .\"    documentation and/or other materials provided with the distribution.
    12. 

  12. .\" 3. All advertising materials mentioning features or use of this software
    13. 

  13. .\"    must display the following acknowledgement:
    14. 

  14. .\"	This product includes software developed by John Birrell.
    15. 

  15. .\" 4. Neither the name of the author nor the names of any co-contributors
    16. 

  16. .\"    may be used to endorse or promote products derived from this software
    17. 

  17. .\"    without specific prior written permission.
    18. 

  18. .\"
    19. 

  19. .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
    20. 

  20. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    21. 

  21. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    22. 

  22. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    23. 

  23. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    24. 

  24. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    25. 

  25. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    26. 

  26. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    27. 

  27. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    28. 

  28. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    29. 

  29. .\" SUCH DAMAGE.
    30. 

  30. .\"
    31. 

  31. .\" $FreeBSD$
    32. 

  32. .\"
    33. 

  33. .Dd April 4, 1996
    34. 

  34. .Dt PTHREAD_SETSPECIFIC 3
    35. 

  35. .Os
    36. 

  36. .Sh NAME
    37. 

  37. .Nm pthread_setspecific
    38. 

  38. .Nd set a thread-specific data value
    39. 

  39. .Sh LIBRARY
    40. 

  40. .Lb libpthread
    41. 

  41. .Sh SYNOPSIS
    42. 

  42. .In pthread.h
    43. 

  43. .Ft int
    44. 

  44. .Fn pthread_setspecific "pthread_key_t key" "const void *value"
    45. 

  45. .Sh DESCRIPTION
    46. 

  46. The
    47. 

  47. .Fn pthread_setspecific
    48. 

  48. function associates a thread-specific value with a
    49. 

  49. .Fa key
    50. 

  50. obtained via a previous call to
    51. 

  51. .Fn pthread_key_create .
    52. 

  52. Different threads can bind different values to the same key.
    53. 

  53. These values are
    54. 

  54. typically pointers to blocks of dynamically allocated memory that have been
    55. 

  55. reserved for use by the calling thread.
    56. 

  56. .Pp
    57. 

  57. The effect of calling
    58. 

  58. .Fn pthread_setspecific
    59. 

  59. with a key value not obtained from
    60. 

  60. .Fn pthread_key_create
    61. 

  61. or after
    62. 

  62. .Fa key
    63. 

  63. has been deleted with
    64. 

  64. .Fn pthread_key_delete
    65. 

  65. is undefined.
    66. 

  66. .Pp
    67. 

  67. The
    68. 

  68. .Fn pthread_setspecific
    69. 

  69. function may be called from a thread-specific data destructor function,
    70. 

  70. however this may result in lost storage or infinite loops.
    71. 

  71. .Sh RETURN VALUES
    72. 

  72. If successful, the
    73. 

  73. .Fn pthread_setspecific
    74. 

  74. function will return zero.
    75. 

  75. Otherwise an error number will be returned to
    76. 

  76. indicate the error.
    77. 

  77. .Sh ERRORS
    78. 

  78. The
    79. 

  79. .Fn pthread_setspecific
    80. 

  80. function will fail if:
    81. 

  81. .Bl -tag -width Er
    82. 

  82. .It Bq Er ENOMEM
    83. 

  83. Insufficient memory exists to associate the value with the
    84. 

  84. .Fa key .
    85. 

  85. .It Bq Er EINVAL
    86. 

  86. The
    87. 

  87. .Fa key
    88. 

  88. value is invalid.
    89. 

  89. .El
    90. 

  90. .Sh SEE ALSO
    91. 

  91. .Xr pthread_getspecific 3 ,
    92. 

  92. .Xr pthread_key_create 3 ,
    93. 

  93. .Xr pthread_key_delete 3
    94. 

  94. .Sh STANDARDS
    95. 

  95. The
    96. 

  96. .Fn pthread_setspecific
    97. 

  97. function conforms to
    98. 

  98. .St -p1003.1-96 .
    99.