share/man/man3/pthread_set_name_np.3

   1 .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd August 12, 2018
  28 .Dt PTHREAD_SET_NAME_NP 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_get_name_np ,
  32 .Nm pthread_set_name_np
  33 .Nd set and retrieve the thread name
  34 .Sh LIBRARY
  35 .Lb libpthread
  36 .Sh SYNOPSIS
  37 .In pthread_np.h
  38 .Ft void
  39 .Fn pthread_get_name_np "pthread_t thread" "char *name" "size_t len"
  40 .Ft void
  41 .Fn pthread_set_name_np "pthread_t thread" "const char *name"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn pthread_set_name_np
  45 function applies a copy of the given
  46 .Fa name
  47 to the given
  48 .Fa thread .
  49 .Pp
  50 The
  51 .Fn pthread_get_name_np
  52 function retrieves the
  53 .Fa name
  54 associated with
  55 .Fa thread .
  56 If
  57 .Fn pthread_set_name_np
  58 was not previously called for
  59 .Fa thread ,
  60 the buffer pointed to by
  61 .Fa name
  62 will be empty.
  63 .Sh ERRORS
  64 Because of the debugging nature of these functions, all errors that may
  65 appear inside are silently ignored.
  66 .Sh SEE ALSO
  67 .Xr thr_set_name 2
  68 .Sh STANDARDS
  69 .Fn pthread_set_name_np
  70 and
  71 .Fn pthread_get_name_np
  72 are non-standard extensions.
  73 .Sh AUTHORS
  74 This manual page was written by
  75 .An Alexey Zelkin Aq Mt phantom@FreeBSD.org
  76 and
  77 .An Yuri Pankov Aq Mt yuripv@yuripv.net .