Thread-Exit-0.09

名前
概要
説明
クラスメソッド
- begin
- end
- inherit
- ismain
必要なモジュール
MOD_PERL
TODO
作者
謝辞
著作権
参考

名前¶

Thread::Exit - スレッドローカルなexit()、BEGIN {}、END {}およびexited()の提供

概要¶

    use Thread::Exit ();   # スレッドローカルなexit()の生成だけ

    use Thread::Exit
     begin => 'begin_sub', # スレッド開始時に実行するルーチン（デフォルト：なし）
     end => 'end_sub',     # スレッド終了時に実行するルーチン（デフォルト：なし）
     inherit => 1,         # 全ての新スレッドが引き継ぐ（デフォルト：1）
    ;

    $thread = threads->new( sub { exit( "We've exited" ) } ); # または "create"
    print $thread->join;            # "We've exited"を出力

    Thread::Exit->ismain;           # このスレッドをメインスレッドとみなす

    Thread::Exit->begin( \$begin_sub ); # 後でBEGINサブルーチンをセット/適応
    Thread::Exit->begin( undef );       # BEGINサブルーチンを無効
    $begin = Thread::Exit->begin;

    Thread::Exit->end( \$end_sub ); # 後でENDサブルーチンをセット/適応
    Thread::Exit->end( undef );     # ENDサブルーチンを無効
    $end = Thread::Exit->end;

    Thread::Exit->inherit( 1 );     # 全ての新スレッドが設定を引き継ぐようにする
    Thread::Exit->inherit( 0 );     # 新スレッドは設定を引き継がない
    $inherit = Thread::Exit->inherit;

説明¶

                  *** A note of CAUTION ***

 This module only functions on Perl versions 5.8.0 and later.
 And then only when threads are enabled with -Dusethreads.  It
 is of no use with any version of Perl before 5.8.0 or without
 threads enabled.

                  *************************

                  *** 注   意   書   き ***

 このモジュールは、Perlのバージョン5.8.0以降で、かつ、-Dusethreads
 オプションでスレッドが有効になっている場合にのみ機能する。5.8.0以前、
 あるいはスレッドが有効になっていない場合は、使うことができない。

                  *************************

This module adds three features to threads that are sorely missed by some.

このモジュールは、人によっては無いと大層困る三つの機能をスレッドに追加する。

The first feature is that you can use exit() within a thread to return() from that thread only. Without this module, exit() stops all threads and exits to the calling process (which usually is the operating system). With this module, exit() functions just as return() (including passing back values to the parent thread).

第一の特徴は、あるスレッドからのみreturn()するために、そのスレッド内部で exit()が使えるようになる。このモジュールを使わないと、exit()は全ての スレッドを停止して、呼び出したプロセス（普通これはオペレーティングシステム）へ抜ける。このモジュールを使うことによって、exit()はまさにreturn()として機能する（値は親スレッドに送られる）。

The second feature is that you can specify a subroutine that will be executed after the thread is started, but before the subroutine of which the thread consists, is started. This is an alternate implementation of the CLONE subroutine, which differs by being really executed inside the context of the new thread (as shown by the value of threads-tid>). Multiple "begin" subroutines can be chained together if necessary.

第二の特徴として、スレッドが開始された後に、ただしスレッドを構成するサブルーチンがスタートする前に、実行されるサブルーチンを指定できる。これは CLONEサブルーチンの違うやり方での実装であり、（threads-tid>の値で示される）新しいスレッドのコンテキスト内部で本当に実行されるという点が異なる。必要とあらば複数の"begin"サブルーチンを繋げることができる。

The third feature is that you can specify a subroutine that will be executed after the thread is done, but before the thread returns to the parent thread. This is similar to the END subroutine, but on a per-thread basis. Multiple "end" subroutines can be chained together if necessary.

三番目の特徴は、スレッドが終了した後に、ただし、そのスレッドが親スレッドに戻る前に、実行されるサブルーチンを指定できるということだ。これは ENDサブルーチンに似ているが、各スレッド毎に基づく。必要とあらば複数の"end"サブルーチンを繋げることができる。

クラスメソッド¶

These are the class methods.

以下はクラスメソッドである。

begin¶

 Thread::Exit->begin( 'begin' );             # "begin"を実行する

 Thread::Exit->begin( undef );               # なにも実行しない

 Thread::Exit->begin( 'module::before',-1 ); # 最初に"module::before"を実行する

 Thread::Exit->begin( \&after,1 );           # 最後に"after"を実行する

 $begin = Thread::Exit->begin;               # 現在のコードリファンレンスを返す

The "begin" class method sets and returns the subroutine that will be executed after the current thread is started but before it starts the actual subroutine of which the thread consists. It is similar to the CLONE subroutine, but is really executed in the context of the thread (whereas CLONE currently fakes this for performance reasons, causing XS routines and threads->tid to be executed in the wrong context).

"begin"クラスメソッドは、現在のスレッドが開始された後に、しかし、そのスレッドを構成する実際のサブルーチンが開始される前に実行されるサブルーチンをセットして返す。これはCLONEサブルーチンに似ているが、そのスレッドのコンテキストで実際に実行される（対してCLONEは今のところ、パフォーマンスの理由からこれを模倣している。その結果、XSルーチンとthreads->tidが間違ったコンテキストで実行される）。

The first input parameter is the name or a reference to the subroutine that should be executed before this thread really starts. It can be specified as a name or as a code reference. No changes will be made if no parameters are specified. If the first parameter is undef()ined or empty, then no subroutine will be executed when this thread has started.

最初の入力パラメータは、このスレッドが本当に開始する前に実行されるサブルーチンの名前かリファレンスである。名前かコードリファレンスを指定できる。パラメータを指定しなければ何も起こらない。最初のパラメータがundefされるか空の場合、このスレッドが開始したときにサブルーチンは実行されない。

The second input parameter only has meaning if there has been a "begin" subroutine specified before. The following values are recognized:

二番目の入力パラメータは、その前に"begin"サブルーチンが設定されているときだけ意味を持つ。次の値を認識する：

replace (0)

If the value 0 is specified, then the new subroutine specification will replace any current "begin" subroutine specification done earlier. This is the default.

0が設定されると、その新しいサブルーチン指定が、先に設定の済んだ現在の "begin"サブルーチンに取って代わる。これはデフォルトである。

after (1)

If the value 1 is specified, then the subroutine specificed will be executed after any other "begin" subroutine that was specified earlier.

1が設定されると、その新しいサブルーチン指定が、先に設定の済んだ他の "begin"サブルーチンの後に実行される。

before (-1)

If the value -1 is specified, then the subroutine specificed will be executed before any other "begin" subroutine that was specified earlier.

-1が設定されると、その新しいサブルーチン指定が、先に設定の済んだ他の "begin"サブルーチンの前に実行される。

By default, new threads inherit the settings of the "begin" subroutine. Check the inherit method to change this.

デフォルトでは、新しいスレッドは"begin"サブルーチンの設定を引き継ぐ。 inheritメソッドを使えばこれを変更できる。

end¶

 Thread::Exit->end( 'end' );               # "end"を実行する

 Thread::Exit->end( undef );               # なにも実行しない

 Thread::Exit->end( 'module::before',-1 ); # 最初に"module::before"を実行する

 Thread::Exit->end( \&after,1 );           # 最後に"after"を実行する

 $end = Thread::Exit->end;                 # 現在のコードリファレンスを返す

The "end" class method sets and returns the subroutine that will be executed after the current thread is finished but before it will return via a join().

"end"クラスメソッドは、現在のスレッドが終了した後に、しかし、join()を通じてスレッドが戻る前に、実行されるサブルーチンを設定して返す。

The "end" subroutine is passed a single flag which is true if the thread is exiting by calling exit(). Please note that the system variable $@ is also set if the thread exited because of a compilation or execution error.

そのスレッドがexit()を呼び出して終了しているなら、"end"サブルーチンは真の値をもつ一つのフラグを渡す。注意して欲しいのは、コンパイルエラーや実行時エラーでスレッドが終了すると、システム変数$@もセットされることだ。

The first input parameter is the name or a reference to the subroutine that should be executed after this thread is finished. It can be specified as a name or as a code reference. No changes will be made if no parameters are specified. If the first parameter is undef()ined or empty, then no subroutine will be executed when this thread ends.

最初の入力パラメータは、このスレッドが終了した後に実行されるサブルーチンの名前かリファレンスである。名前かコードリファレンスを指定できる。パラメータを指定しなければ何も起こらない。最初のパラメータがundefされるか空の場合、このスレッドが終了したときにサブルーチンは実行されない。

The second input parameter only has meaning if there has been an "end" subroutine specified before. The following values are recognized:

二番目の入力パラメータは、その前に"end"サブルーチンが設定されているときだけ意味を持つ。次の値を認識する：

replace (0)

If the value 0 is specified, then the new subroutine specification will replace any current "end" subroutine specification done earlier. This is the default.

0が設定されると、その新しいサブルーチン指定が、先に設定の済んだ現在の "end"サブルーチンに取って代わる。これはデフォルトである。

after (1)

If the value 1 is specified, then the subroutine specificed will be executed after any other "end" subroutine that was specified earlier.

1が設定されると、その新しいサブルーチン指定が、先に設定の済んだ他の "end"サブルーチンの後に実行される。

before (-1)

If the value -1 is specified, then the subroutine specificed will be executed before any other "end" subroutine that was specified earlier.

-1が設定されると、その新しいサブルーチン指定が、先に設定の済んだ他の "end"サブルーチンの前に実行される。

By default, new threads inherit the settings of the "end" subroutine. Check the inherit method to change this.

デフォルトでは、新しいスレッドは"end"サブルーチンの設定を引き継ぐ。 inheritメソッドを使えばこれを変更できる。

inherit¶

 Thread::Exit->inherit( 1 );         # デフォルト、新スレッドは継承する

 Thread::Exit->inherit( 0 );         # 新スレッドは継承しない

 $inherit = Thread::Exit->inherit;   # 現在の設定を返す

The "inherit" class method sets and returns whether newly created threads will inherit the "begin" and "end" subroutine settings (as previously indicated with a call to the begin or end class methods).

"inherit"クラスメソッドは、新たに生成されるスレッドが"begin"および"end" サブルーチンの設定（既に示したようにbeginあるいはendクラスメソッドを呼び出す）を引き継ぐかどうか設定して返す。

If an input parameter is specified, it indicates the new setting of this flag. A true value indicates that new threads should inherit the "begin" and "end" subroutine settings. A false value indicates that new threads should not have any "begin" or "end" subroutine (unless of course specified otherwise inside the thread after the thread has started).

入力パラメータが指定されると、このフラグの新しい設定が示される。真値は新しいスレッドが"begin"および"end"サブルーチンの設定を引き継ぐことを示す。偽値は新しいスレッドが"begin"ないし"end"サブルーチンを持たないことを示している（もちろん、そのスレッドがスタートした後に、スレッド内で違う設定を指定しない限りにおいて）。

The default settings is 1, causing begin and end settings to be inherited by newly created threads.

デフォルトの設定は1だ。新しく生成されるスレッドは、beginとend の設定を引き継ぐことになる。

ismain¶

 Thread::Exit->ismain;

The "ismain" class method is only needed in very special situation. It marks the current thread as the "main" thread from which a "real" exit() should occur.

"ismain"クラスメソッドは、非常に特別な場合にのみ必要となる。このメソッドは現在のスレッドを"main"スレッドとして印付け、このmainスレッドから"本当の"exit()が呼び出される。

By default, only the thread in which the use Thread::Exit occurred, will perform a "real" exit (either to CORE::exit() or to Apache::exit() when in a mod_perl environment). This may however, not always be right. In those cases you can use this class method.

デフォルトでは、use Thread::Exitが現れたスレッドだけが"本当の"exitを実行する（CORE::exit()あるいはmod_perl環境ではApache::exit()のいずれか）。これはしかし、常に正しいというわけではない。場合によってはこのクラスメソッドを使える。

必要なモジュール¶

 load (0.12)

MOD_PERL¶

To allow this module to function under Apache with mod_perl, a special check is included for the existence of the Apache::exit() subroutine. If the Apache::exit() subroutine exists, then that exit routine will be preferred over the CORE::exit() routine when exiting from the thread in which the first use Thread::Exit occurred.

このモジュールがmod_perlを使うApacheの下で機能するために、Apache::exit() サブルーチンが存在するか調べる特別なチェックが含まれる。Apache::exit()が存在するなら、最初のuse Thread::Exitが現れたスレッドから抜けるときに、 CORE::exit()よりもこのexitルーチンがされる。

TODO¶

Examples should be added.

例の追加。

作者¶

Elizabeth Mattijsen, <liz@dijkmat.nl>.

Please report bugs to <perlbugs@dijkmat.nl>.

謝辞¶

Nick Ing-Simmons and Rafael Garcia-Suarez for their suggestions and support. Mike Pomraning for pointing out that die() can also take a reference as a parameter inside an eval(), so that the dependency on Thread::Serialize could be removed.

著作権¶

参考¶

threads.