class Thread::Mutex

aliases: Mutex

要約

Mutex(Mutal Exclusion = 相互排他ロック)は共有データを並行アクセスから保護するためにあります。Mutex の典型的な使い方は(m を Mutex オブジェクトとします):

m.lock
begin
  # m によって保護されたクリティカルセクション
ensure
  m.unlock
end

または、より簡単に

m.synchronize {
  # m によって保護されたクリティカルセクション
}

目次

特異メソッド

• new

インスタンスメソッド

• lock
• locked?
• owned?
• sleep
• synchronize
• try_lock
• unlock

特異メソッド

new -> Thread::Mutex[permalink][rdoc][edit]

新しい mutex を生成して返します。

インスタンスメソッド

lock -> self[permalink][rdoc][edit]

mutex オブジェクトをロックします。一度に一つのスレッドだけが mutex をロックできます。既にロックされている mutex に対してロックを行おうとしたスレッドは mutex のロックが解放されるまで、実行が停止されます。

[EXCEPTION] ThreadError:

self 既にカレントスレッドにロックされている場合に発生します。また、Signal.#trap に指定したハンドラ内で実行した場合に発生します。

[SEE_ALSO] Thread::Mutex#unlock

locked? -> bool[permalink][rdoc][edit]

mutex がロックされている時、真を返します。

例

m = Mutex.new
m.locked? # => false
m.lock
m.locked? # => true

owned? -> bool[permalink][rdoc][edit]

self がカレントスレッドによってロックされている場合に true を返します。そうでない場合に false を返します。

例

m = Mutex.new
m.owned? # => false
m.lock
Thread.new do
  m.owned? # => false
end.join
m.owned? # => true

sleep(timeout = nil) -> Integer[permalink][rdoc][edit]

与えられた秒数の間ロックを解除してスリープして、実行後にまたロックします。

[PARAM] timeout:

スリープする秒数を指定します。省略するとスリープし続けます。

[RETURN]

タイムアウトした時は nil を、それ以外はスリープしていた秒数を返します。

[EXCEPTION] ThreadError:

自身がカレントスレッドによってロックされていない場合に発生します。

[注意] 2.0 以降ではスリープ中でも、シグナルを受信した場合などに実行が再開(spurious wakeup)される場合がある点に注意してください。

例

m = Mutex.new
th = Thread.new do
  m.lock
  m.sleep(2)
end
th.status # => "run"
sleep 1
th.status # => "sleep"
sleep 1
th.status # => false

synchronize { ... } -> object[permalink][rdoc][edit]

mutex をロックし、ブロックを実行します。実行後に必ず mutex のロックを解放します。

ブロックが最後に評価した値を返します。

[EXCEPTION] ThreadError:

self 既にカレントスレッドにロックされている場合に発生します。また、Signal.#trap に指定したハンドラ内で実行した場合に発生します。

例

m = Mutex.new
result = m.synchronize do
  m.locked? # => true
  # critical part
  "result"
end
m.locked? # => false
result # => "result"

try_lock -> bool[permalink][rdoc][edit]

mutex をロックしようとして、ロックが成功した場合、真を返します。ロックできなかった場合にはブロックせず偽を返します。

例

m = Mutex.new
m.try_lock # => true
m.try_lock # => false

unlock -> self[permalink][rdoc][edit]

mutex のロックを解放します。mutex のロック待ちになっていたスレッドの実行は再開されます。

[RETURN]

self を返します。

例:

m = Mutex.new
begin
  m.lock
  # critical part
ensure
  m.unlock
end

Mutex はロックしたスレッド以外からロックを開放することは出来ません。ロックしたスレッド以外から unlock が呼ばれると ThreadError が発生します。

m = Mutex.new
m.lock
Thread.new do
  m.unlock # => ThreadError
end.join

[EXCEPTION] ThreadError:

self がロックされていない場合や self をロックしたスレッド以外から呼ばれた場合に発生します。また、Signal.#trap に指定したハンドラ内で実行した場合に発生します。