Nicholas Clark > perl > Thread::Semaphore

Download:
perl-5.8.9.tar.bz2

Annotate this POD

Website

Related Modules

Thread::Queue
Net::SNMP
Thread::RWLock
IO::Socket
IO::File
Win32::OLE
IO::Handle
Data::Dumper
Net::DNS
File::Find
more...
By perlmonks.org
Source  

NAME ^

Thread::Semaphore - thread-safe semaphores (5.005-threads)

CAVEAT ^

This Perl installation is using the old unsupported "5.005 threads". Use of the old threads model is discouraged.

For the whole story about the development of threads in Perl, and why you should not be using "old threads" unless you know what you're doing, see the CAVEAT of the Thread module.

SYNOPSIS ^

    use Thread::Semaphore;
    my $s = new Thread::Semaphore;
    $s->up;     # Also known as the semaphore V -operation.
    # The guarded section is here
    $s->down;   # Also known as the semaphore P -operation.

    # The default semaphore value is 1.
    my $s = new Thread::Semaphore($initial_value);
    $s->up($up_value);
    $s->down($up_value);

DESCRIPTION ^

Semaphores provide a mechanism to regulate access to resources. Semaphores, unlike locks, aren't tied to particular scalars, and so may be used to control access to anything you care to use them for.

Semaphores don't limit their values to zero or one, so they can be used to control access to some resource that may have more than one of. (For example, filehandles) Increment and decrement amounts aren't fixed at one either, so threads can reserve or return multiple resources at once.

FUNCTIONS AND METHODS ^

new
new NUMBER

new creates a new semaphore, and initializes its count to the passed number. If no number is passed, the semaphore's count is set to one.

down
down NUMBER

The down method decreases the semaphore's count by the specified number, or one if no number has been specified. If the semaphore's count would drop below zero, this method will block until such time that the semaphore's count is equal to or larger than the amount you're downing the semaphore's count by.

up
up NUMBER

The up method increases the semaphore's count by the number specified, or one if no number's been specified. This will unblock any thread blocked trying to down the semaphore if the up raises the semaphore count above what the downs are trying to decrement it by.

syntax highlighting: