util/X86LINUX64/man/man3/Tcl_FinalizeThread.3

   1 '\"
   2 '\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH Tcl_Exit 3 8.5 Tcl "Tcl Library Procedures"
   8 .\" The -*- nroff -*- definitions below are for supplemental macros used
   9 .\" in Tcl/Tk manual entries.
  10 .\"
  11 .\" .AP type name in/out ?indent?
  12 .\"     Start paragraph describing an argument to a library procedure.
  13 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  14 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  15 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  16 .\"     needed;  use .AS below instead)
  17 .\"
  18 .\" .AS ?type? ?name?
  19 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  20 .\"     name are examples of largest possible arguments that will be passed
  21 .\"     to .AP later.  If args are omitted, default tab stops are used.
  22 .\"
  23 .\" .BS
  24 .\"     Start box enclosure.  From here until next .BE, everything will be
  25 .\"     enclosed in one large box.
  26 .\"
  27 .\" .BE
  28 .\"     End of box enclosure.
  29 .\"
  30 .\" .CS
  31 .\"     Begin code excerpt.
  32 .\"
  33 .\" .CE
  34 .\"     End code excerpt.
  35 .\"
  36 .\" .VS ?version? ?br?
  37 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  38 .\"     of man pages.  The first argument is ignored and used for recording
  39 .\"     the version when the .VS was added, so that the sidebars can be
  40 .\"     found and removed when they reach a certain age.  If another argument
  41 .\"     is present, then a line break is forced before starting the sidebar.
  42 .\"
  43 .\" .VE
  44 .\"     End of vertical sidebar.
  45 .\"
  46 .\" .DS
  47 .\"     Begin an indented unfilled display.
  48 .\"
  49 .\" .DE
  50 .\"     End of indented unfilled display.
  51 .\"
  52 .\" .SO ?manpage?
  53 .\"     Start of list of standard options for a Tk widget. The manpage
  54 .\"     argument defines where to look up the standard options; if
  55 .\"     omitted, defaults to "options". The options follow on successive
  56 .\"     lines, in three columns separated by tabs.
  57 .\"
  58 .\" .SE
  59 .\"     End of list of standard options for a Tk widget.
  60 .\"
  61 .\" .OP cmdName dbName dbClass
  62 .\"     Start of description of a specific option.  cmdName gives the
  63 .\"     option's name as specified in the class command, dbName gives
  64 .\"     the option's name in the option database, and dbClass gives
  65 .\"     the option's class in the option database.
  66 .\"
  67 .\" .UL arg1 arg2
  68 .\"     Print arg1 underlined, then print arg2 normally.
  69 .\"
  70 .\" .QW arg1 ?arg2?
  71 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  72 .\"
  73 .\" .PQ arg1 ?arg2?
  74 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  75 .\"     (for trailing punctuation) and then a closing parenthesis.
  76 .\"
  77 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  78 .if t .wh -1.3i ^B
  79 .nr ^l \n(.l
  80 .ad b
  81 .\"     # Start an argument description
  82 .de AP
  83 .ie !"\\$4"" .TP \\$4
  84 .el \{\
  85 .   ie !"\\$2"" .TP \\n()Cu
  86 .   el          .TP 15
  87 .\}
  88 .ta \\n()Au \\n()Bu
  89 .ie !"\\$3"" \{\
  90 \&\\$1 \\fI\\$2\\fP (\\$3)
  91 .\".b
  92 .\}
  93 .el \{\
  94 .br
  95 .ie !"\\$2"" \{\
  96 \&\\$1  \\fI\\$2\\fP
  97 .\}
  98 .el \{\
  99 \&\\fI\\$1\\fP
 100 .\}
 101 .\}
 102 ..
 103 .\"     # define tabbing values for .AP
 104 .de AS
 105 .nr )A 10n
 106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 107 .nr )B \\n()Au+15n
 108 .\"
 109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 111 ..
 112 .AS Tcl_Interp Tcl_CreateInterp in/out
 113 .\"     # BS - start boxed text
 114 .\"     # ^y = starting y location
 115 .\"     # ^b = 1
 116 .de BS
 117 .br
 118 .mk ^y
 119 .nr ^b 1u
 120 .if n .nf
 121 .if n .ti 0
 122 .if n \l'\\n(.lu\(ul'
 123 .if n .fi
 124 ..
 125 .\"     # BE - end boxed text (draw box now)
 126 .de BE
 127 .nf
 128 .ti 0
 129 .mk ^t
 130 .ie n \l'\\n(^lu\(ul'
 131 .el \{\
 132 .\"     Draw four-sided box normally, but don't draw top of
 133 .\"     box if the box started on an earlier page.
 134 .ie !\\n(^b-1 \{\
 135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 136 .\}
 137 .el \}\
 138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 139 .\}
 140 .\}
 141 .fi
 142 .br
 143 .nr ^b 0
 144 ..
 145 .\"     # VS - start vertical sidebar
 146 .\"     # ^Y = starting y location
 147 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 148 .de VS
 149 .if !"\\$2"" .br
 150 .mk ^Y
 151 .ie n 'mc \s12\(br\s0
 152 .el .nr ^v 1u
 153 ..
 154 .\"     # VE - end of vertical sidebar
 155 .de VE
 156 .ie n 'mc
 157 .el \{\
 158 .ev 2
 159 .nf
 160 .ti 0
 161 .mk ^t
 162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 163 .sp -1
 164 .fi
 165 .ev
 166 .\}
 167 .nr ^v 0
 168 ..
 169 .\"     # Special macro to handle page bottom:  finish off current
 170 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 171 .\"     # page bottom macro.
 172 .de ^B
 173 .ev 2
 174 'ti 0
 175 'nf
 176 .mk ^t
 177 .if \\n(^b \{\
 178 .\"     Draw three-sided box if this is the box's first page,
 179 .\"     draw two sides but no top otherwise.
 180 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .\}
 183 .if \\n(^v \{\
 184 .nr ^x \\n(^tu+1v-\\n(^Yu
 185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 186 .\}
 187 .bp
 188 'fi
 189 .ev
 190 .if \\n(^b \{\
 191 .mk ^y
 192 .nr ^b 2
 193 .\}
 194 .if \\n(^v \{\
 195 .mk ^Y
 196 .\}
 197 ..
 198 .\"     # DS - begin display
 199 .de DS
 200 .RS
 201 .nf
 202 .sp
 203 ..
 204 .\"     # DE - end display
 205 .de DE
 206 .fi
 207 .RE
 208 .sp
 209 ..
 210 .\"     # SO - start of list of standard options
 211 .de SO
 212 'ie '\\$1'' .ds So \\fBoptions\\fR
 213 'el .ds So \\fB\\$1\\fR
 214 .SH "STANDARD OPTIONS"
 215 .LP
 216 .nf
 217 .ta 5.5c 11c
 218 .ft B
 219 ..
 220 .\"     # SE - end of list of standard options
 221 .de SE
 222 .fi
 223 .ft R
 224 .LP
 225 See the \\*(So manual entry for details on the standard options.
 226 ..
 227 .\"     # OP - start of full description for a single option
 228 .de OP
 229 .LP
 230 .nf
 231 .ta 4c
 232 Command-Line Name:      \\fB\\$1\\fR
 233 Database Name:  \\fB\\$2\\fR
 234 Database Class: \\fB\\$3\\fR
 235 .fi
 236 .IP
 237 ..
 238 .\"     # CS - begin code excerpt
 239 .de CS
 240 .RS
 241 .nf
 242 .ta .25i .5i .75i 1i
 243 ..
 244 .\"     # CE - end code excerpt
 245 .de CE
 246 .fi
 247 .RE
 248 ..
 249 .\"     # UL - underline word
 250 .de UL
 251 \\$1\l'|0\(ul'\\$2
 252 ..
 253 .\"     # QW - apply quotation marks to word
 254 .de QW
 255 .ie '\\*(lq'"' ``\\$1''\\$2
 256 .\"" fix emacs highlighting
 257 .el \\*(lq\\$1\\*(rq\\$2
 258 ..
 259 .\"     # PQ - apply parens and quotation marks to word
 260 .de PQ
 261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 262 .\"" fix emacs highlighting
 263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 264 ..
 265 .\"     # QR - quoted range
 266 .de QR
 267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 268 .\"" fix emacs highlighting
 269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 270 ..
 271 .\"     # MT - "empty" string
 272 .de MT
 273 .QW ""
 274 ..
 275 .BS
 276 .SH NAME
 277 Tcl_Exit, Tcl_Finalize, Tcl_CreateExitHandler, Tcl_DeleteExitHandler, Tcl_ExitThread, Tcl_FinalizeThread, Tcl_CreateThreadExitHandler, Tcl_DeleteThreadExitHandler, Tcl_SetExitProc \- end the application or thread (and invoke exit handlers)
 278 .SH SYNOPSIS
 279 .nf
 280 \fB#include <tcl.h>\fR
 281 .sp
 282 \fBTcl_Exit\fR(\fIstatus\fR)
 283 .sp
 284 \fBTcl_Finalize\fR()
 285 .sp
 286 \fBTcl_CreateExitHandler\fR(\fIproc, clientData\fR)
 287 .sp
 288 \fBTcl_DeleteExitHandler\fR(\fIproc, clientData\fR)
 289 .sp
 290 \fBTcl_ExitThread\fR(\fIstatus\fR)
 291 .sp
 292 \fBTcl_FinalizeThread\fR()
 293 .sp
 294 \fBTcl_CreateThreadExitHandler\fR(\fIproc, clientData\fR)
 295 .sp
 296 \fBTcl_DeleteThreadExitHandler\fR(\fIproc, clientData\fR)
 297 .sp
 298 Tcl_ExitProc *
 299 \fBTcl_SetExitProc\fR(\fIproc\fR)
 300 .SH ARGUMENTS
 301 .AS Tcl_ExitProc clientData
 302 .AP int status  in
 303 Provides information about why the application or thread exited.
 304 Exact meaning may
 305 be platform-specific.  0 usually means a normal exit, any nonzero value
 306 usually means that an error occurred.
 307 .AP Tcl_ExitProc *proc in
 308 Procedure to invoke before exiting application, or (for
 309 \fBTcl_SetExitProc\fR) NULL to uninstall the current application exit
 310 procedure.
 311 .AP ClientData clientData in
 312 Arbitrary one-word value to pass to \fIproc\fR.
 313 .BE
 314
 315 .SH DESCRIPTION
 316 .PP
 317 The procedures described here provide a graceful mechanism to end the
 318 execution of a \fBTcl\fR application. Exit handlers are invoked to cleanup the
 319 application's state before ending the execution of \fBTcl\fR code.
 320 .PP
 321 Invoke \fBTcl_Exit\fR to end a \fBTcl\fR application and to exit from this
 322 process. This procedure is invoked by the \fBexit\fR command, and can be
 323 invoked anyplace else to terminate the application.
 324 No-one should ever invoke the \fBexit\fR system procedure directly;  always
 325 invoke \fBTcl_Exit\fR instead, so that it can invoke exit handlers.
 326 Note that if other code invokes \fBexit\fR system procedure directly, or
 327 otherwise causes the application to terminate without calling
 328 \fBTcl_Exit\fR, the exit handlers will not be run.
 329 \fBTcl_Exit\fR internally invokes the \fBexit\fR system call, thus it never
 330 returns control to its caller.
 331 If an application exit handler has been installed (see
 332 \fBTcl_SetExitProc\fR), that handler is invoked with an argument
 333 consisting of the exit status (cast to ClientData); the application
 334 exit handler should not return control to Tcl.
 335 .PP
 336 \fBTcl_Finalize\fR is similar to \fBTcl_Exit\fR except that it does not
 337 exit from the current process.
 338 It is useful for cleaning up when a process is finished using \fBTcl\fR but
 339 wishes to continue executing, and when \fBTcl\fR is used in a dynamically
 340 loaded extension that is about to be unloaded.
 341 Your code should always invoke \fBTcl_Finalize\fR when \fBTcl\fR is being
 342 unloaded, to ensure proper cleanup. \fBTcl_Finalize\fR can be safely called
 343 more than once.
 344 .PP
 345 \fBTcl_ExitThread\fR is used to terminate the current thread and invoke
 346 per-thread exit handlers.  This finalization is done by
 347 \fBTcl_FinalizeThread\fR, which you can call if you just want to clean
 348 up per-thread state and invoke the thread exit handlers.
 349 \fBTcl_Finalize\fR calls \fBTcl_FinalizeThread\fR for the current
 350 thread automatically.
 351 .PP
 352 \fBTcl_CreateExitHandler\fR arranges for \fIproc\fR to be invoked
 353 by \fBTcl_Finalize\fR and \fBTcl_Exit\fR.
 354 \fBTcl_CreateThreadExitHandler\fR arranges for \fIproc\fR to be invoked
 355 by \fBTcl_FinalizeThread\fR and \fBTcl_ExitThread\fR.
 356 This provides a hook for cleanup operations such as flushing buffers
 357 and freeing global memory.
 358 \fIProc\fR should match the type \fBTcl_ExitProc\fR:
 359 .PP
 360 .CS
 361 typedef void \fBTcl_ExitProc\fR(
 362         ClientData \fIclientData\fR);
 363 .CE
 364 .PP
 365 The \fIclientData\fR parameter to \fIproc\fR is a
 366 copy of the \fIclientData\fR argument given to
 367 \fBTcl_CreateExitHandler\fR or \fBTcl_CreateThreadExitHandler\fR when
 368 the callback
 369 was created.  Typically, \fIclientData\fR points to a data
 370 structure containing application-specific information about
 371 what to do in \fIproc\fR.
 372 .PP
 373 \fBTcl_DeleteExitHandler\fR and \fBTcl_DeleteThreadExitHandler\fR may be
 374 called to delete a
 375 previously-created exit handler.  It removes the handler
 376 indicated by \fIproc\fR and \fIclientData\fR so that no call
 377 to \fIproc\fR will be made.  If no such handler exists then
 378 \fBTcl_DeleteExitHandler\fR or \fBTcl_DeleteThreadExitHandler\fR does nothing.
 379 .PP
 380 \fBTcl_Finalize\fR and \fBTcl_Exit\fR execute all registered exit handlers,
 381 in reverse order from the order in which they were registered.
 382 This matches the natural order in which extensions are loaded and unloaded;
 383 if extension \fBA\fR loads extension \fBB\fR, it usually
 384 unloads \fBB\fR before it itself is unloaded.
 385 If extension \fBA\fR registers its exit handlers before loading extension
 386 \fBB\fR, this ensures that any exit handlers for \fBB\fR will be executed
 387 before the exit handlers for \fBA\fR.
 388 .PP
 389 \fBTcl_Finalize\fR and \fBTcl_Exit\fR call \fBTcl_FinalizeThread\fR
 390 and the thread exit handlers \fIafter\fR
 391 the process-wide exit handlers.  This is because thread finalization shuts
 392 down the I/O channel system, so any attempt at I/O by the global exit
 393 handlers will vanish into the bitbucket.
 394 .PP
 395 \fBTcl_SetExitProc\fR installs an application exit handler, returning
 396 the previously-installed application exit handler or NULL if no
 397 application handler was installed.  If an application exit handler is
 398 installed, that exit handler takes over complete responsibility for
 399 finalization of Tcl's subsystems via \fBTcl_Finalize\fR at an
 400 appropriate time.  The argument passed to \fIproc\fR when it is
 401 invoked will be the exit status code (as passed to \fBTcl_Exit\fR)
 402 cast to a ClientData value.
 403 .SH "SEE ALSO"
 404 exit(n)
 405 .SH KEYWORDS
 406 abort, callback, cleanup, dynamic loading, end application, exit, unloading, thread