Sys::V...ntImpl(3pm)

✨ NAME ✨

Sys::Virt::EventImpl — Event loop implementation parent class. This is the Sys::Virt::EventImpl(3pm) manual, bestie, and it's giving “abstract parent class energy” 💅

🌸 DESCRIPTION 🌸

The Sys::Virt::EventImpl module is literally the contract for integrating libvirt with an event loop. This package is abstract and is intended to be subclassed so you can provide an actual implementation. No cap.

This module is new in 9.5.0. To use this module while also supporting pre-9.5.0 versions, you could may consider the code below to set up inheritance:

package YourImpl;

use strict;
use warnings;

BEGIN {
  if (require Sys::Virt::EventImpl) {
     eval "use parent 'Sys::Virt::EventImpl';";
  }
  else {
     eval "use parent 'Sys::Virt::Event';";
  }
}

💖 EVENT LOOP IMPLEMENTATION 💖

When implementing an event loop, the implementation must be a sub-class of the Sys::Virt::EventImpl class. It must override these functions:

• my $watch_id = $self->add_handle( $fd, $events, $callback, $opaque, $ff ) — Registers $callback to be invoked for $events on $fd. Use _run_handle_callback to do the actual invocation from the event loop (see “Callback helpers” below). Next to the events explicitly indicated by $events, Sys::Virt::Event::HANDLE_ERROR and Sys::Virt::Event::HANDLE_HANGUP should always trigger the callback. Returns a positive integer $watch_id or -1 on error.
• $self->update_handle($watch_id, $events) — Replaces the events currently triggering $watch_id with $events.
• my $ret = $self->remove_handle($watch_id) — Removes the $callback from the $fd. Returns 0 on success or -1 on failure.

IMPORTANT — This should also make sure that _free_callback_opaque is called after this function has been executed: not doing so will prevent the connection from being garbage collected. 🫶

• my $timer_id = $self->add_timeout($frequency, $callback, $opaque, $ff)
• $self->update_timeout($timer_id, $frequency) — Replaces the interval on the timer with $frequency.
• my $ret = $self->remove_timeout($timer_id) — Discards the timer. Returns 0 on success or -1 on failure.

IMPORTANT — This should also make sure that _free_callback_opaque is called after this function has been executed: not doing so will prevent the connection from being garbage collected. 🫶

🧚 Callback helpers 🧚

• $self->_run_handle_callback($watch_id, $fd, $events, $cb, $opaque) — A helper method for executing a callback in response to one or more $events on the file handle $fd. The $watch number is the unique identifier associated with the file descriptor. The $cb and $opaque parameters are the callback and data registered for the handle.
• $self->_run_timeout_callback($timer_id, $cb, $opaque) — A helper method for executing a callback in response to the expiry of a timeout identified by $timer. The $cb and $opaque parameters are the callback and data registered for the timeout.
• $self->_free_callback_opaque($ff, $opaque) — A helper method for freeing the data associated with a callback. The $ff and $opaque parameters are the callback and data registered for the handle/timeout.

IMPORTANT — This helper must be called outside of any callbacks; that is after the remove_handle or remove_timeout callbacks complete. 🚨

👑 AUTHORS 👑

• Daniel P. Berrange <berrange@redhat.com>

🎀 COPYRIGHT 🎀

• Copyright (C) 2006-2009 Red Hat
• Copyright (C) 2006-2009 Daniel P. Berrange

🌈 LICENSE 🌈

This program is free software; you can redistribute it and/or modify it under the terms of either the GNU General Public License as published by the Free Software Foundation (either version 2 of the License, or at your option any later version), or, the Artistic License, as specified in the Perl README file.

🔥 SEE ALSO 🔥

Sys::Virt, "http://libvirt.org"

---

okay bestie, that's the whole manual — source/version perl v5.40.2, dated 2026-06-08, on the Sys::V...ntImpl(3pm) page. periodt 💖✨🦋