Tirex::Renderer(3pm)

💖 Tirex::Renderer — a Tirex renderer config 💖

okay so this is Tirex::Renderer(3pm), straight outta the User Contributed Perl Documentation, and bestie it is exactly what it says on the tin: it's the class that holds one renderer's config. iconic. let's get into it 🎀

---

✨ NAME ✨

Tirex::Renderer — A Tirex renderer config. that's it. that's the whole vibe. a renderer config, as a class. 💅

---

🌸 SYNOPSIS 🌸

my $r = Tirex::Renderer->new( ... );

look at her. one line. she's serving.

---

🦋 DESCRIPTION 🦋

so Tirex can lowkey work with several rendering backends — think Mapnik, think WMS, the whole roster. and each backend can be started with a different configuration, like fr for Mapnik you gotta configure the font directory and stuff. so this class exists to define the methods that read the config files

/etc/tirex/renderer/*.conf

which are the things describing all those backend configurations, and to manage those renderers. you're welcome 🫶

and if you wanna see the actual code of some backends, go look at the class Tirex::Backend and its subclasses. that's where the real work lives. iykyk ✨

---

👑 METHODS 👑

💜 Tirex::Renderer->read_config_dir($dir)

read all the renderer configs in the given config directory. all of them. every single one. slay.

💜 Tirex::Renderer->get('foo')

get a renderer by name. pass the name, get the renderer. periodt.

💜 Tirex::Renderer->all();

return a sorted (by name) list of all configured renderers. sorted by name, so it's giving organized. 💅

💜 Tirex::Renderer->clear();

clear the list of renderers. poof. gone. 🙈

💜 Tirex::Renderer->enabled();

return a sorted (by name) list of all the enabled renderers. notice how it's not all of them. this is the enabled-only club 🌈

💜 Tirex::Renderer->new( name => 'foo', path => '/path/to/exec', port => 1234, procs => 3, ... )

create a new renderer config. main character energy only 💖

so every renderer has at least these general options: name, path, port, and procs. will croak if they are not all present. all four. no skipping, bestie, it will croak at you 😭

plus it can also have zero or more options that are specific to that renderer. so like, extra toppings. go wild.

⚠️ will croak if a renderer configuration already exists under the same name. no duplicate names. the name is taken, move on 💀

💜 Tirex::Renderer->new_from_configfile($filename)

create a new renderer config from a file. yes, from a file, we're doing filesystem things 🌸

⚠️ croaks if the file does not exist. so maybe make sure it exists first?? just a thought 🥺

💜 $rend->read_map_config()

read all map configs for this renderer. every map config. for this renderer specifically. 🗺️✨

💜 $rend->get_maps()

get an array of map configs for this renderer. it's an array, it's map configs, it's hers ✨

💜 $rend->get_config()

return a hash with the renderer-specific configuration. the specific stuff. the custom bits. 💜

💜 $rend->get_name();

get the name of this renderer. simple. iconic. 🎀

💜 $rend->get_debug();

get the debug flag of this renderer. is it debug mode? find out ⌨️

💜 $rend->get_path();

get the path of this renderer. where does she live 🏠

💜 $rend->get_port();

get the port of this renderer. the number. the connection point. 🔥

💜 $rend->get_procs();

get procs of this renderer. how many procs. that many 🌟

💜 $rend->get_syslog_facility();

get the syslog facility of this renderer. ya, syslog facility, we log things here 📝

💜 $rend->is_enabled()

is this renderer enabled? boolean moment. yes or no bestie 💅

💜 $rend->disable();

disable this renderer. she's off duty now 💤

💜 $rend->enable();

enable this renderer. she's BACK and she's ready 🔥👑

💜 $rend->to_s();

return a human readable description of this renderer. for the humans 🫶

💜 $rend->to_hash();

return the parameters of this renderer as a hash. hash o'clock 💜

💜 Tirex::Renderer->status();

return the status of all configured renderers. all of them. every single status. 👀

💜 $rend->add_worker($pid);

add a process id to the list of currently running workers. welcome to the team, $pid 🎉

💜 $rend->remove_worker($pid);

remove a process id from the list of currently running workers. bye $pid, we hardly knew ye 😭

💜 $rend->num_workers();

return the number of currently running workers. just a number. a lil count. math is math 🧮

---

💌 SEE ALSO 💌

so the original page doesn't have a SEE ALSO section, but it does shout out Tirex::Backend and its subclasses up in the DESCRIPTION, so go check those out if you want the actual backend code. that's your homework 🎀

---

okay that's the whole page, no cap. this was written against perl v5.40.1 and the page is dated 2026-08-09, part of the User Contributed Perl Documentation for Tirex::Renderer(3pm). thanks for reading bestie, go configure a renderer, you're gonna ate 💅💖✨🦋🌸🫶👑