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 June 3, 2020
  28 .Dt PTHREAD_SET_NAME_NP 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_get_name_np ,
  32 .Nm pthread_getname_np ,
  33 .Nm pthread_set_name_np
  34 .Nm pthread_setname_np
  35 .Nd set and retrieve the thread name
  36 .Sh LIBRARY
  37 .Lb libpthread
  38 .Sh SYNOPSIS
  39 .In pthread_np.h
  40 .Ft void
  41 .Fn pthread_get_name_np "pthread_t thread" "char *name" "size_t len"
  42 .Ft void
  43 .Fn pthread_getname_np "pthread_t thread" "char *name" "size_t len"
  44 .Ft void
  45 .Fn pthread_set_name_np "pthread_t thread" "const char *name"
  46 .Ft void
  47 .Fn pthread_setname_np "pthread_t thread" "const char *name"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn pthread_set_name_np
  51 and
  52 .Fn pthread_setname_np
  53 functions applies a copy of the given
  54 .Fa name
  55 to the given
  56 .Fa thread .
  57 .Pp
  58 The
  59 .Fn pthread_get_name_np
  60 and
  61 .Fn pthread_getname_np
  62 functions retrieves the
  63 .Fa name
  64 associated with
  65 .Fa thread .
  66 If
  67 .Fn pthread_set_name_np
  68 was not previously called for
  69 .Fa thread ,
  70 the buffer pointed to by
  71 .Fa name
  72 will be empty.
  73 .Sh ERRORS
  74 Because of the debugging nature of these functions, all errors that may
  75 appear inside are silently ignored.
  76 .Sh SEE ALSO
  77 .Xr thr_set_name 2
  78 .Sh STANDARDS
  79 .Fn pthread_set_name_np
  80 and
  81 .Fn pthread_get_name_np
  82 are non-standard extensions.
  83 .Fn pthread_setname_np
  84 and
  85 .Fn pthread_getname_np
  86 are also non-standard, but are implemented by larger number of operating
  87 systems so they are in fact more portable.
  88 .Sh AUTHORS
  89 This manual page was written by
  90 .An Alexey Zelkin Aq Mt phantom@FreeBSD.org
  91 and
  92 .An Yuri Pankov Aq Mt yuripv@yuripv.net .