---
name: "Tirex::Manager::Bucket"
section: "3pm"
platform: "linux"
package: "tirex"
version: "0.7.1-3+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Tirex::Manager::Bucket"
---

# Tirex::Manager::Bucket(3pm)

Rendering buckets for different priorities

## NAME

Tirex::Manager::Bucket - Rendering buckets for different priorities

## SYNOPSIS

```
 use Tirex::Manager::Bucket;
 my $bucket = Tirex::Manager::Bucket->new( name => 'test', minprio => 1, maxproc => 8, maxload => 20 );
```

## DESCRIPTION

To simplify the configuration of rendering parameters for different zoom levels, they are configured through Buckets. One Bucket contains the configuration for a range of zoom levels.

## METHODS

### Tirex::Manager::Bucket-\>new( name =\> $name, minprio =\> $minprio, maxproc =\> $maxproc, maxload =\> $maxload )

Create new rendering bucket.

### $bucket-\>add\_job($job)

Add a Tirex::Job to bucket.

### $bucket-\>remove\_job($job)

Remove a Tirex::Job from bucket.

### $bucket-\>get\_name()

Get name of bucket.

### $bucket-\>get\_numproc()

Returns the number of rendering processes currently working on jobs in this bucket.

### $bucket-\>get\_minprio()

Get minimum priority for this bucket.

### $bucket-\>get\_maxprio()

Get maximum priority for this bucket. The maximum priority has to be set with **set\_maxprio()** before this works.

### $bucket-\>set\_maxprio($maxprio)

Set maximum priority for this bucket.

### $bucket-\>get\_active()

Get active flag for this bucket.

### $bucket-\>set\_active($active)

Set active flag for this bucket.

### $bucket-\>for\_prio($prio)

Check whether this bucket is the right one for the given priority, ie. whether the priority is between min- and maxprio.

### $bucket-\>can\_render($num\_rendering, $current\_load)

Finds out if a job in this rendering bucket can be rendered.

Returns

```
 1     if it can be rendered
 0     if there are already maxproc or more rendering processes
       or if bucket is not active
 undef if the load is higher or equal than maxload
```

### $bucket-\>status($num\_rendering, $current\_load)

Return status of bucket.