lib/Thread/Cleanup.pm

   1 package Thread::Cleanup;
   2
   3 use 5.008;
   4
   5 use strict;
   6 use warnings;
   7
   8 =head1 NAME
   9
  10 Thread::Cleanup - Hook thread destruction.
  11
  12 =head1 VERSION
  13
  14 Version 0.04
  15
  16 =cut
  17
  18 our $VERSION;
  19
  20 BEGIN {
  21  $VERSION = '0.04';
  22  require XSLoader;
  23  XSLoader::load(__PACKAGE__, $VERSION);
  24 }
  25
  26 =head1 SYNOPSIS
  27
  28     use Thread::Cleanup;
  29
  30     use threads;
  31
  32     Thread::Cleanup::register {
  33      my $tid = threads->tid();
  34      warn "Thread $tid finished\n";
  35     };
  36
  37 =head1 DESCRIPTION
  38
  39 This module allows you to hook thread destruction without fiddling with the internals of L<threads>.
  40
  41 It acts globally on all the threads that may spawn anywhere in your program, with the exception of the main thread.
  42
  43 =head1 FUNCTIONS
  44
  45 =head2 C<register>
  46
  47     register { ... };
  48     &register($coderef);
  49
  50 Specify that the given block or code reference C<$coderef> will have to be called (in void context, without arguments) every time a thread finishes its job.
  51 More precisely,
  52
  53 =over 4
  54
  55 =item *
  56
  57 it will always be called before the joining for joined threads ;
  58
  59 =item *
  60
  61 it will be called for detached threads if and only if they terminate before the main thread, and the hook will then fire at C<END> time ;
  62
  63 =item *
  64
  65 it won't trigger for the destruction of the main thread.
  66
  67 =back
  68
  69 =cut
  70
  71 my @callbacks;
  72
  73 sub register (&) { push @callbacks, shift }
  74
  75 sub _CLEANUP { $_->() for @callbacks }
  76
  77 =head1 EXPORT
  78
  79 None.
  80
  81 =head1 DEPENDENCIES
  82
  83 L<perl> 5.8.
  84
  85 A C compiler.
  86 This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard.
  87
  88 L<threads> 1.07.
  89
  90 L<XSLoader>.
  91
  92 =head1 AUTHOR
  93
  94 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
  95
  96 =head1 BUGS
  97
  98 Please report any bugs or feature requests to C<bug-thread-cleanup at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Thread-Cleanup>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
  99
 100 =head1 SUPPORT
 101
 102 You can find documentation for this module with the perldoc command.
 103
 104     perldoc Thread::Cleanup
 105
 106 =head1 ACKNOWLEDGEMENTS
 107
 108 Inspired by a question from TonyC on #p5p.
 109
 110 =head1 COPYRIGHT & LICENSE
 111
 112 Copyright 2009,2010,2013 Vincent Pit, all rights reserved.
 113
 114 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 115
 116 =cut
 117
 118 1; # End of Thread::Cleanup