xref: /illumos-gate/usr/src/man/man3proc/Pdestroy_agent.3proc (revision 8c69cc8fbe729fa7b091e901c4b50508ccc6bb33)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2015 Joyent, Inc.
13.\"
14.Dd May 11, 2016
15.Dt PDESTROY_AGENT 3PROC
16.Os
17.Sh NAME
18.Nm Pdestroy_agent
19.Nd destroy the agent LWP
20.Sh SYNOPSIS
21.Lb libproc
22.In libproc.h
23.Ft void
24.Fo Pdestroy_agent
25.Fa "struct ps_prochandle *P"
26.Fc
27.Sh DESCRIPTION
28The
29.Fn Pdestroy_agent
30function
31removes the agent LWP in
32.Fa P .
33The existence of the agent LWP is reference counted by the library and
34therefore if
35.Xr Pcreate_agent 3PROC
36has been called multiple times, the
37.Fn Pdestroy_agent
38function must be called an equal number of times.
39Upon the last time, it will destroy the agent LWP.
40.Pp
41Destroying the agent LWP does not change the state of the process
42represented by
43.Fa P .
44.Sh INTERFACE STABILITY
45.Sy Uncommitted
46.Sh MT-LEVEL
47See
48.Sy LOCKING
49in
50.Xr libproc 3LIB .
51.Sh SEE ALSO
52.Xr libproc 3LIB ,
53.Xr Pcreate_agent 3PROC
54