Event::generic(3)

💖 NAME 💖

Event::generic — generic event handling. That’s the whole vibe, bestie. ✨

This is the Event::generic(3) page from the User Contributed Perl Documentation, so you already know it’s gonna be a little niche and a little iconic. 🫶

✨ SYNOPSIS ✨

use Event::generic;

$source = Event::generic::Source->new;

$w = Event->generic(source => $source, ...);
$w = $source->watch(...);

$source = $w->source;
$w->source($source);

$source->event;
$source->event($data);

$data = $event->data;

🌸 DESCRIPTION 🌸

Okay so this module gives you a watcher type inside the Event framework. But real talk: you must understand the architecture of the Event system before this document will make sense — no skipping the lore, bestie. 💅

It gives you a system of reified event sources and watchers watching those sources. Events are generated solely by a method on the event source object. Those events may carry arbitrary data to the event handler callbacks. This module is intended for situations where the events of interest are best determined by Perl code. It’s giving “let Perl decide what counts as an event,” and honestly? Slay. 💖

🎀 CLASSES 🎀

• Event::generic::Source — a reified event source. The source of the source, if you will. ✨
• Event::generic — a watcher that can watch Event::generic::Source event sources. 👀
• Event::Event::Dataful — a (target) event that can carry arbitrary data. Dataful and booked. 🍓

🌟 EVENT SOURCE CLASS 🌟

🧚 Constructor 🧚

• Event::generic::Source->new — creates and returns a new event source. Fresh source, no cap. 🫶

💅 Methods 💅

• $source->event
• $source->event(DATA)

Invoking this method is a source event for watchers of the event source. When this method is called, each active watcher of the event source generates a target event. The DATA, if supplied, is copied into the target event objects, from which it can be retrieved using the data() method. Like passing a little note in class — except the note is arbitrary data and the class is event handling. 😭

• $source->watch(ATTR => VALUE, ...) — generates and returns a new watcher, configured to watch this event source. The standard watcher attributes may be specified as arguments. The watcher returned is an ordinary Event::generic, and may be reconfigured to watch a different event source. Reusable watcher? We love a flexible icon. 🌈

🔥 WATCHER CLASS 🔥

🎀 Type-specific attributes 🎀

• source => $source — the event source to watch. This must be either an Event::generic::Source object or undef. When set to undef, no source is being watched, and the watcher cannot be started. So if you set it to undef, it’s literally not beating the “can’t start” allegations. 💀

⭐ EVENT CLASS ⭐

🍓 Type-specific methods 🍓

• $event->data — returns the data associated with the event, which may be any scalar. This is read-only, and is set by the event source. So no take-backs, bestie; the source already decided. 🙈

🌈 SEE ALSO 🌈

• Event — the main character, obviously. 👑

---

Later, bestie! 💖 This page is from perl v5.42.0, dated 2021-04-30 — Event::generic(3), mwah. 🎀✨