/share/man/man3/pthread_attr_setcreatesuspend_np.3

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

    

  1. .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
    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. .\"
    13. 

  13. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    14. 

  14. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    15. 

  15. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    16. 

  16. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    17. 

  17. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    18. 

  18. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    19. 

  19. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    20. 

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

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

  22. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    23. 

  23. .\" SUCH DAMAGE.
    24. 

  24. .\"
    25. 

  25. .\" $FreeBSD$
    26. 

  26. .\"
    27. 

  27. .Dd February 13, 2003
    28. 

  28. .Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
    29. 

  29. .Os
    30. 

  30. .Sh NAME
    31. 

  31. .Nm pthread_attr_setcreatesuspend_np
    32. 

  32. .Nd prepare attribute for creation of suspended thread
    33. 

  33. .Sh LIBRARY
    34. 

  34. .Lb libpthread
    35. 

  35. .Sh SYNOPSIS
    36. 

  36. .In pthread_np.h
    37. 

  37. .Ft int
    38. 

  38. .Fn pthread_attr_setcreatesuspend_np "pthread_attr_t *attr"
    39. 

  39. .Sh DESCRIPTION
    40. 

  40. The
    41. 

  41. .Fn pthread_attr_setcreatesuspend_np
    42. 

  42. instructs
    43. 

  43. .Xr pthread_create 3
    44. 

  44. that the thread created with the
    45. 

  45. .Fa attr
    46. 

  46. attribute
    47. 

  47. should be created and left in a suspended state until explicitly resumed
    48. 

  48. by the call to
    49. 

  49. .Fn pthread_resume_np
    50. 

  50. or
    51. 

  51. .Fn pthread_resume_all_np .
    52. 

  52. .Sh RETURN VALUES
    53. 

  53. .Rv -std pthread_attr_setcreatesuspend_np
    54. 

  54. .Sh ERRORS
    55. 

  55. The
    56. 

  56. .Fn pthread_attr_setcreatesuspend_np
    57. 

  57. function will fail if:
    58. 

  58. .Bl -tag -width Er
    59. 

  59. .It Bq Er EINVAL
    60. 

  60. The value specified by
    61. 

  61. .Fa attr
    62. 

  62. is invalid.
    63. 

  63. .El
    64. 

  64. .Sh SEE ALSO
    65. 

  65. .Xr pthread_attr_destroy 3 ,
    66. 

  66. .Xr pthread_attr_init 3 ,
    67. 

  67. .Xr pthread_create 3 ,
    68. 

  68. .Xr pthread_resume_all_np 3 ,
    69. 

  69. .Xr pthread_resume_np 3
    70. 

  70. .Sh AUTHORS
    71. 

  71. This manual page was written by
    72. 

  72. .An Alexey Zelkin Aq phantom@FreeBSD.org .
    73.