xref: /illumos-gate/usr/src/man/man3proc/Pdestroy_agent.3proc (revision 9b9d39d2a32ff806d2431dbcc50968ef1e6d46b2)
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 LIBRARY
21.Lb libproc
22.Sh SYNOPSIS
23.In libproc.h
24.Ft void
25.Fo Pdestroy_agent
26.Fa "struct ps_prochandle *P"
27.Fc
28.Sh DESCRIPTION
29The
30.Fn Pdestroy_agent
31function
32removes the agent LWP in
33.Fa P .
34The existence of the agent LWP is reference counted by the library and
35therefore if
36.Xr Pcreate_agent 3PROC
37has been called multiple times, the
38.Fn Pdestroy_agent
39function must be called an equal number of times.
40Upon the last time, it will destroy the agent LWP.
41.Pp
42Destroying the agent LWP does not change the state of the process
43represented by
44.Fa P .
45.Sh INTERFACE STABILITY
46.Sy Uncommitted
47.Sh MT-LEVEL
48See
49.Sy LOCKING
50in
51.Xr libproc 3LIB .
52.Sh SEE ALSO
53.Xr libproc 3LIB ,
54.Xr Pcreate_agent 3PROC
55