vcs.maemo.org Git - pkg-perl/blob - deb-src/libwx-perl/libwx-perl-0.96/blib/man3/Wx::Thread.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Wx::Thread 3"
 132 .TH Wx::Thread 3 "2007-04-29" "perl v5.8.3" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Thread \- using wxPerl with threads
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 4
 138 \&  # the order of these use()s is important
 139 \&  use threads;
 140 \&  use threads::shared;
 141 \&  use Wx;
 142 .Ve
 143 .PP
 144 .Vb 1
 145 \&  my $DONE_EVENT : shared = Wx::NewEventType;
 146 .Ve
 147 .PP
 148 .Vb 1
 149 \&  my $worker = threads->create( \e&work );
 150 .Ve
 151 .PP
 152 .Vb 4
 153 \&  # create frames, etc
 154 \&  my $frame = Wx::Frame->new( ... );
 155 \&  EVT_COMMAND( $frame, -1, $DONE_EVENT, \e&done );
 156 \&  $app->MainLoop;
 157 .Ve
 158 .PP
 159 .Vb 2
 160 \&  sub done {
 161 \&      my( $frame, $event ) = @_;
 162 .Ve
 163 .PP
 164 .Vb 2
 165 \&      print $event->GetData;
 166 \&  }
 167 .Ve
 168 .PP
 169 .Vb 2
 170 \&  sub work {
 171 \&      # ... do stuff, create a shared $result value
 172 .Ve
 173 .PP
 174 .Vb 3
 175 \&      my $threvent = new Wx::PlThreadEvent( -1, $DONE_EVENT, $result );
 176 \&      Wx::PostEvent( $frame, $threvent );
 177 \&  }
 178 .Ve
 179 .PP
 180 .Vb 4
 181 \&  # event handler
 182 \&  sub OnCreateThread {
 183 \&      # @_ = () is necessary to avoid "Scalars leaked"
 184 \&      my( $self, $event ) = @_; @_ = ();
 185 .Ve
 186 .PP
 187 .Vb 2
 188 \&      threads->create( ... );
 189 \&  }
 190 .Ve
 191 .SH "DESCRIPTION"
 192 .IX Header "DESCRIPTION"
 193 Threaded \s-1GUI\s0 application are somewhat different from non-GUI threaded
 194 applications in that the main thread (which runs the \s-1GUI\s0) must never
 195 block.  Also, in wxWidgets, no thread other than the main thread can
 196 manipulate \s-1GUI\s0 objects.  This leads to a hybrid model where worker
 197 threads must send events to the main thread in order to change the \s-1GUI\s0
 198 state or signal their termination.
 199 .Sh "Order of module loading"
 200 .IX Subsection "Order of module loading"
 201 It's necessary for \f(CW\*(C`use Wx\*(C'\fR to happen after <use threads::shared>.
 202 .Sh "Sending events from worker threads"
 203 .IX Subsection "Sending events from worker threads"
 204 \&\f(CW\*(C`Wx::PlThreadEvent\*(C'\fR can be used to communicate between worker and
 205 \&\s-1GUI\s0 threads.  The event can carry a \fIshared\fR value between threads.
 206 .PP
 207 .Vb 1
 208 \&  my $DONE_EVENT : shared = Wx::NewEventType;
 209 .Ve
 210 .PP
 211 .Vb 4
 212 \&  sub work {
 213 \&      # ... do some stuff
 214 \&      my $progress = new Wx::PlThreadEvent( -1, $DONE_EVENT, $progress );
 215 \&      Wx::PostEvent( $frame, $progress );
 216 .Ve
 217 .PP
 218 .Vb 4
 219 \&      # ... do stuff, create a shared $result value
 220 \&      my $end = new Wx::PlThreadEvent( -1, $DONE_EVENT, $result );
 221 \&      Wx::PostEvent( $frame, $end );
 222 \&  }
 223 .Ve
 224 .PP
 225 The target of the event can be any \f(CW\*(C`Wx::EvtHandler\*(C'\fR
 226 .Sh "Receiving events from worker threads"
 227 .IX Subsection "Receiving events from worker threads"
 228 \&\f(CW\*(C`Wx::PlThreadEvent\*(C'\fR is a command event and can be handled as such.
 229 The \f(CW\*(C`\->GetData\*(C'\fR method can be used to retrieve the \fIshared\fR data
 230 contained inside the event.
 231 .PP
 232 .Vb 1
 233 \&  my $DONE_EVENT : shared = Wx::NewEventType;
 234 .Ve
 235 .PP
 236 .Vb 1
 237 \&  EVT_COMMAND( $frame, -1, $DONE_EVENT, \e&done );
 238 .Ve
 239 .PP
 240 .Vb 2
 241 \&  sub done {
 242 \&      my( $frame, $event ) = @_;
 243 .Ve
 244 .PP
 245 .Vb 2
 246 \&      print $event->GetData;
 247 \&  }
 248 .Ve
 249 .Sh "Creating new threads"
 250 .IX Subsection "Creating new threads"
 251 Creating new threads from event handlers works without problems except
 252 from a little snag.  In order not to trigger a bug in the Perl
 253 interpreter, all event handler that directly or indirectly cause a
 254 thread creation must clean \f(CW@_\fR before starting the thread.
 255 .PP
 256 For example:
 257 .PP
 258 .Vb 2
 259 \&  sub OnCreateThread {
 260 \&      my( $self, $event ) = @_; @_ = ();
 261 .Ve
 262 .PP
 263 .Vb 2
 264 \&      threads->create( ... );
 265 \&  }
 266 .Ve
 267 .PP
 268 failure to do that will cause \*(L"scalars leaked\*(R" warnings from the Perl
 269 interpreter.