share/man/man3c/thrd_exit.3c

   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 2016 Joyent, Inc.
  13 .\"
  14 .Dd "Jan 13, 2015"
  15 .Dt THRD_EXIT 3C
  16 .Os
  17 .Sh NAME
  18 .Nm thrd_exit
  19 .Nd terminate a thread
  20 .Sh SYNOPSIS
  21 .In threads.h
  22 .Ft "_Noreturn void"
  23 .Fo thrd_exit
  24 .Fa "int res"
  25 .Fc
  26 .Sh DESCRIPTION
  27 The
  28 .Fn thrd_exit
  29 function terminates the calling thread, in a similar way that
  30 .Xr exit 3C
  31 terminates the calling process.
  32 If the calling thread has not been detached, then the exit status information
  33 provided in
  34 .Fa res
  35 is saved and can be retrieved by the use of the
  36 .Xr thrd_join 3C
  37 function.
  38 .Pp
  39 When the thread exits, all signals will be blocked and various
  40 destructors and clean up handlers will be called, such as those
  41 registered with
  42 .Xr tss_create 3C .
  43 The act of thread termination does not cause any process-wide resources,
  44 such as mutexes and file descriptors to be released.
  45 .Pp
  46 If a thread, other than the thread in which
  47 .Fn main
  48 was first invoked returns from its starting routine, it will implicitly
  49 call
  50 .Fn thrd_exit
  51 and set the return value to be its exit status.
  52 .Sh RETURN VALUES
  53 The
  54 .Fn thrd_exit
  55 function does not return, the calling thread is terminated.
  56 .Sh INTERFACE STABILITY
  57 .Sy Standard
  58 .Sh MT-LEVEL
  59 .Sy MT-Safe
  60 .Sh SEE ALSO
  61 .Xr pthread_exit 3C ,
  62 .Xr thr_exit 3C ,
  63 .Xr attributes 5 ,
  64 .Xr attributes 5 ,
  65 .Xr threads 5