xref: /freebsd/share/man/man3/pthread_set_name_np.3 (revision 4627d47bc83903d3bf89828e32f3a4c3322a31d2)
1318d8cfdSAlexey Zelkin.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
2318d8cfdSAlexey Zelkin.\" All rights reserved.
3318d8cfdSAlexey Zelkin.\"
4318d8cfdSAlexey Zelkin.\" Redistribution and use in source and binary forms, with or without
5318d8cfdSAlexey Zelkin.\" modification, are permitted provided that the following conditions
6318d8cfdSAlexey Zelkin.\" are met:
7318d8cfdSAlexey Zelkin.\" 1. Redistributions of source code must retain the above copyright
8318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer.
9318d8cfdSAlexey Zelkin.\" 2. Redistributions in binary form must reproduce the above copyright
10318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer in the
11318d8cfdSAlexey Zelkin.\"    documentation and/or other materials provided with the distribution.
12318d8cfdSAlexey Zelkin.\"
13318d8cfdSAlexey Zelkin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14318d8cfdSAlexey Zelkin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15318d8cfdSAlexey Zelkin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16318d8cfdSAlexey Zelkin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17318d8cfdSAlexey Zelkin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18318d8cfdSAlexey Zelkin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19318d8cfdSAlexey Zelkin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20318d8cfdSAlexey Zelkin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21318d8cfdSAlexey Zelkin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22318d8cfdSAlexey Zelkin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23318d8cfdSAlexey Zelkin.\" SUCH DAMAGE.
24318d8cfdSAlexey Zelkin.\"
25318d8cfdSAlexey Zelkin.\" $FreeBSD$
26318d8cfdSAlexey Zelkin.\"
27*4627d47bSKonstantin Belousov.Dd August 12, 2018
28318d8cfdSAlexey Zelkin.Dt PTHREAD_SET_NAME_NP 3
29318d8cfdSAlexey Zelkin.Os
30318d8cfdSAlexey Zelkin.Sh NAME
31*4627d47bSKonstantin Belousov.Nm pthread_get_name_np ,
32318d8cfdSAlexey Zelkin.Nm pthread_set_name_np
33*4627d47bSKonstantin Belousov.Nd set and retrieve the thread name
34318d8cfdSAlexey Zelkin.Sh LIBRARY
35ec7452f1SRuslan Ermilov.Lb libpthread
36318d8cfdSAlexey Zelkin.Sh SYNOPSIS
37318d8cfdSAlexey Zelkin.In pthread_np.h
38318d8cfdSAlexey Zelkin.Ft void
39*4627d47bSKonstantin Belousov.Fn pthread_get_name_np "pthread_t thread" "char *name" "size_t len"
40*4627d47bSKonstantin Belousov.Ft void
41ff07dd91SEric van Gyzen.Fn pthread_set_name_np "pthread_t thread" "const char *name"
42318d8cfdSAlexey Zelkin.Sh DESCRIPTION
43318d8cfdSAlexey ZelkinThe
44318d8cfdSAlexey Zelkin.Fn pthread_set_name_np
45ff07dd91SEric van Gyzenfunction applies a copy of the given
46318d8cfdSAlexey Zelkin.Fa name
47ff07dd91SEric van Gyzento the given
48ff07dd91SEric van Gyzen.Fa thread .
49*4627d47bSKonstantin Belousov.Pp
50*4627d47bSKonstantin BelousovThe
51*4627d47bSKonstantin Belousov.Fn pthread_get_name_np
52*4627d47bSKonstantin Belousovfunction retrieves the
53*4627d47bSKonstantin Belousov.Fa name
54*4627d47bSKonstantin Belousovassociated with
55*4627d47bSKonstantin Belousov.Fa thread .
56*4627d47bSKonstantin BelousovIf
57*4627d47bSKonstantin Belousov.Fn pthread_set_name_np
58*4627d47bSKonstantin Belousovwas not previously called for
59*4627d47bSKonstantin Belousov.Fa thread ,
60*4627d47bSKonstantin Belousovthe buffer pointed to by
61*4627d47bSKonstantin Belousov.Fa name
62*4627d47bSKonstantin Belousovwill be empty.
63318d8cfdSAlexey Zelkin.Sh ERRORS
64*4627d47bSKonstantin BelousovBecause of the debugging nature of these functions, all errors that may
65ace5be68SRuslan Ermilovappear inside are silently ignored.
66ff07dd91SEric van Gyzen.Sh SEE ALSO
67ff07dd91SEric van Gyzen.Xr thr_set_name 2
68*4627d47bSKonstantin Belousov.Sh STANDARDS
69*4627d47bSKonstantin Belousov.Fn pthread_set_name_np
70*4627d47bSKonstantin Belousovand
71*4627d47bSKonstantin Belousov.Fn pthread_get_name_np
72*4627d47bSKonstantin Belousovare non-standard extensions.
73318d8cfdSAlexey Zelkin.Sh AUTHORS
74ace5be68SRuslan ErmilovThis manual page was written by
75*4627d47bSKonstantin Belousov.An Alexey Zelkin Aq Mt phantom@FreeBSD.org
76*4627d47bSKonstantin Belousovand
77*4627d47bSKonstantin BelousovAn Yuri Pankov Aq Mt yuripv@yuripv.net .
78