Tirex:...odTile(3pm)

💖 Tirex::Source::ModTile — the manual page, but make it serve 💖

okay bestie, this is Tirex::Source::ModTile, a Perl module living in section 3pm of the User Contributed Perl Documentation. it's the little glow-up that lets mod_tile be a source of job requests. 🌸

---

✨ NAME ✨

Tirex::Source::ModTile — mod_tile as a source of job requests, fr fr. 💅

---

🎀 SYNOPSIS 🎀

 my $source = &Tirex::Source::ModTile->new();
 $source->notify();

look at that. immaculate. no notes. ✨

---

🦋 DESCRIPTION 🦋

this source lowkey eats: it uses Tirex messages sent through mod_tile, over a Unix domain socket. that's the whole vibe. 👑

---

💅 METHODS 💅

Tirex::Source::ModTile->new()

creates the source object for the Unix domain socket connection. it's giving new beginnings. 🫶

$source->readable($sock)

tells this source that the socket you passed in is readable and actually has data for it. main character data. 📥

what it gives back:

• STATUS_CONTINUE — it expects to keep reading, hold on bestie
• STATUS_MESSAGE_COMPLETE — reading is done, periodt ✅
• STATUS_SOCKET_CLOSED — the peer closed the connection 💀

$source->make_job($sock)

returns a brand new Tirex::Job object built from the data this source read. it also decides whether this source wants to be notified when the job finishes, and if yes, it flags the job accordingly. multitasking icon. 🎀

these are the priority levels used in the Apache mod_tile and how they get translated in Tirex. ⚠️ important note: in mod_tile the numbers do not imply higher or lower priority. don't read into them, they're just numbers.

cmdRender (1 in mod_tile, 2 in Tirex)

this priority is what mod_tile uses when a "very old" tile is requested. the config option ModTileVeryOldThreshold controls what counts as "very old". unless the system load is higher than ModTileMaxLoadOld, a render request gets triggered and mod_tile waits for up to ModTileRequestTimeout seconds. if no tile is produced in that time, the old tile is returned. no thoughts, just the old tile. 🙈

cmdDirty (2 in mod_tile, 10 in Tirex)

this priority is what mod_tile uses when:

• the /dirty URL is manually called for a tile
• an "old" or "very old" tile is requested but the load is too high to render it right away (the old tile will be delivered instead)
• a "missing" tile is requested but the load is too high to render it right away (a 404 error will be issued)

cmdRenderPrio (5 in mod_tile, 1 in Tirex)

this priority is used by mod_tile when a "missing" tile is requested. unless the system load is higher than ModTileMaxLoadMissing, a render request is triggered and mod_tile waits for up to ModTileMissingRequestTimeout seconds. if a tile isn't produced within that time, a 404 error will be issued. 😭

cmdRenderBulk (6 in mod_tile, 20 in Tirex)

used for all "missing tile" render requests triggered by mod_tile when "ModTileBulkMode On" is set in the Apache configuration. in this mode, requests for old tiles are never issued. it is never used if "ModTileBulkMode Off" — which is the default, btw. 🔥

cmdRenderLow (7 in mod_tile, 25 in Tirex)

this priority is used by mod_tile when an "old" tile is requested. an "old" tile is one that's older than three days or, if a planet_import_complete file is present, older than this file. unless the system load is higher than ModTileMaxLoadOld, a render request gets triggered and mod_tile waits for up to ModTileRequestTimeout seconds. if no tile is produced within that time, the old tile is returned. ✨

$source->set_request_write_callback(\&wcb}

specifies a function to be called if this source ever wants to receive writable events. (yes the brace situation in there is exactly as written, i'm not touching it, that's the original's business, not mine 🫶)

$source->notify($job)

preps a notification message about successful tile rendering, and tells the main select loop to give us a chance to write. teamwork, baby. 🌈

$source->writable($sock)

tells this source that the socket you passed in is writable. 📤

then it attempts to send the prepared notification message and returns:

• STATUS_MESSAGE_COMPLETE — if the message has been fully sent 🎉
• STATUS_CONTINUE — if sending needs to continue later ⏳
• STATUS_SOCKET_CLOSED — if the peer has closed the connection 💀

---

and that's the whole page, bestie!! tysm for reading, i'm obsessed with you for real. this was perl v5.40.1, dated 2026-08-09, brought to you by the User Contributed Perl Documentation gang. slay, no cap, go write some flawless Perl. 💖✨🎀🦋🌸💅🫶👑