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.Dd October 12, 2021 26.Dt PTHREAD_SUSPEND_NP 3 27.Os 28.Sh NAME 29.Nm pthread_suspend_np 30.Nd suspend a thread 31.Sh LIBRARY 32.Lb libpthread 33.Sh SYNOPSIS 34.In pthread_np.h 35.Ft int 36.Fn pthread_suspend_np "pthread_t tid" 37.Sh DESCRIPTION 38The 39.Fn pthread_suspend_np 40function, called on an active thread, causes it to suspend. 41.Pp 42It is not safe for the caller of the 43.Fn pthread_suspend_np 44function to use any non-async signal safe functions, except 45.Xr pthread_resume_np 3 , 46until suspended thread is resumed, unless measures are taken to ensure 47that the thread is suspended at a safe point. 48.Sh RETURN VALUES 49If successful, 50.Fn pthread_suspend_np 51function returns 0. 52Otherwise, an error number is returned to indicate the error. 53.Sh ERRORS 54The 55.Fn pthread_suspend_np 56function will fail if: 57.Bl -tag -width Er 58.It Bq Er EDEADLK 59An attempt was made to suspend the current thread. 60.It Bq Er EINVAL 61The value specified by the 62.Fa tid 63argument is invalid. 64.It Bq Er ESRCH 65No thread could be found corresponding to the thread ID specified by the 66.Fa tid 67argument. 68.El 69.Sh SEE ALSO 70.Xr pthread_np 3 , 71.Xr pthread_resume_all_np 3 , 72.Xr pthread_resume_np 3 , 73.Xr pthread_suspend_all_np 3 74.Sh AUTHORS 75This manual page was written by 76.An Alexey Zelkin Aq Mt phantom@FreeBSD.org . 77