This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Nearly-working threads re-structuring. Do not integrate,
[perl5.git] / ext / threads / threads.pm
1 package threads;
2
3 use 5.7.2;
4 use strict;
5 use warnings;
6
7 use overload
8     '==' => \&equal,
9     'fallback' => 1;
10
11 #use threads::Shared;
12
13 BEGIN {
14     warn "Warning, threads::shared has already been loaded. ".
15        "To enable shared variables for these modules 'use threads' ".
16        "must be called before any of those modules are loaded\n"
17                if($threads::shared::threads_shared);
18 }
19
20 require Exporter;
21 require DynaLoader;
22
23 our @ISA = qw(Exporter DynaLoader);
24
25 our %EXPORT_TAGS = ( all => [qw()]);
26
27 our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
28
29 our @EXPORT = qw(
30         
31 );
32 our $VERSION = '0.05';
33
34
35 sub equal {
36     return 1 if($_[0]->tid() == $_[1]->tid());
37     return 0;
38 }
39
40 $threads::threads = 1;
41
42 bootstrap threads $VERSION;
43
44 # why document 'new' then use 'create' in the tests!
45 *create = \&new;
46
47 # Preloaded methods go here.
48
49 1;
50 __END__
51
52 =head1 NAME
53
54 threads - Perl extension allowing use of interpreter based threads from perl
55
56 =head1 SYNOPSIS
57
58 use threads;
59
60 sub start_thread {
61     print "Thread started\n";
62 }
63
64 my $thread = threads->new("start_thread","argument");
65
66 $thread->new(sub { print "I am a thread"},"argument");
67
68 $thread->join();
69
70 $thread->detach();
71
72 $thread = threads->self();
73
74 threads->tid();
75 threads->self->tid();
76
77 $thread->tid();
78
79 =head1 DESCRIPTION
80
81 Perl 5.6 introduced something called interpreter threads.  Interpreter
82 threads are different from "5005threads" (the thread model of Perl
83 5.005) by creating a new perl interpreter per thread and not sharing
84 any data or state between threads.
85
86 Prior to perl 5.8 this has only been available to people embedding
87 perl and for emulating fork() on windows.
88
89 The threads API is loosely based on the old Thread.pm API. It is very
90 important to note that variables are not shared between threads, all
91 variables are per default thread local.  To use shared variables one
92 must use threads::shared.
93
94 It is also important to note that you preferably enable threads by
95 doing C<use threads> as early as possible and that it is not possible
96 to enable threading inside an eval "";  In particular, if you are
97 intending to share variables with threads::shared, you must
98 C<use threads> before you C<use threads::shared> and threads will emit
99 a warning if you do it the other way around.
100
101 =over
102
103 =item $thread = new(function, LIST)
104
105 This will create a new thread with the entry point function and give
106 it LIST as parameters.  It will return the corresponding threads
107 object.
108
109 create() is an alias to new.
110
111 =item $thread->join
112
113 This will wait for the corresponding thread to join. When it finishes
114 join will return the return values of the entry point function.  If a
115 thread has been detached, join will return without wait.
116
117 =item $thread->detach
118
119 Will throw away the return value from the thread and make it
120 non-joinable.
121
122 =item threads->self
123
124 This will return the object for the current thread.
125
126 =item $thread->tid
127
128 This will return the id of the thread.  threads->self->tid() is a
129 quick way to get current thread id.
130
131 =back
132
133
134 =head1 TODO
135
136 =over
137
138 =item Fix so the return value is returned when you join.
139
140 =item Add join_all.
141
142 =item Fix memory leaks!
143
144 =back
145
146 =head1 AUTHOR and COPYRIGHT
147
148 Arthur Bergman E<lt>arthur at contiller.seE<gt>
149
150 threads is released under the same license as Perl.
151
152 Thanks to
153
154 Richard Soderberg E<lt>rs at crystalflame.netE<gt>
155 Helping me out tons, trying to find reasons for races and other weird bugs!
156
157 Simon Cozens E<lt>simon at brecon.co.ukE<gt>
158 Being there to answer zillions of annoying questions
159
160 Rocco Caputo E<lt>troc at netrus.netE<gt>
161
162 Vipul Ved Prakash E<lt>mail at vipul.netE<gt>
163 Helping with debugging.
164
165 please join perl-ithreads@perl.org for more information
166
167 =head1 BUGS
168
169 =over
170
171 =item creating a thread from within a thread is unsafe under win32
172
173 =item PERL_OLD_SIGNALS are not threadsafe, will not be.
174
175
176 =back
177
178 =head1 SEE ALSO
179
180 L<perl>, L<threads::shared>, L<perlcall>, L<perlembed>, L<perlguts>
181
182 =cut