.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sys::Virt::Event 3pm"
.TH Sys::Virt::Event 3pm "2014-10-02" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sys::Virt::Event \- An event loop contract
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::Event\*(C'\fR module represents the contract for integrating
libvirt with an event loop. This package is abstract and intended to
be subclassed to provide an actual implementation.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fIregister_default()\fR" 4
.IX Item "register_default()"
Register the default libvirt event loop implementation
.IP "\fIrun_default()\fR" 4
.IX Item "run_default()"
Run a single iteration of the default event loop implementation
.IP "register($impl)" 4
.IX Item "register($impl)"
Register an event loop implementation. The implementation should be a
instance of a sub-class of the \f(CW\*(C`Sys::Virt::Event\*(C'\fR package.
.ie n .IP "$self\->_run_handle_callback($watch, $fd, $events, $cb, $opaque)" 4
.el .IP "\f(CW$self\fR\->_run_handle_callback($watch, \f(CW$fd\fR, \f(CW$events\fR, \f(CW$cb\fR, \f(CW$opaque\fR)" 4
.IX Item "$self->_run_handle_callback($watch, $fd, $events, $cb, $opaque)"
A helper method for executing a callback in response to one of more
\&\f(CW$events\fR on the file handle \f(CW$fd\fR. The \f(CW$watch\fR number is the
unique idenifier associated with the file descriptor. The \f(CW$cb\fR
and \f(CW$opaque\fR parameters are the callback and data registered for
the handle.
.ie n .IP "$self\->_run_timeout_callback($timer, $cb, $opaque)" 4
.el .IP "\f(CW$self\fR\->_run_timeout_callback($timer, \f(CW$cb\fR, \f(CW$opaque\fR)" 4
.IX Item "$self->_run_timeout_callback($timer, $cb, $opaque)"
A helper method for executing a callback in response to the
expiry of a timeout identified by \f(CW$timer\fR. The \f(CW$cb\fR
and \f(CW$opaque\fR parameters are the callback and data registered for
the timeout.
.ie n .IP "$self\->_free_callback_opaque($ff, $opaque)" 4
.el .IP "\f(CW$self\fR\->_free_callback_opaque($ff, \f(CW$opaque\fR)" 4
.IX Item "$self->_free_callback_opaque($ff, $opaque)"
A helper method for freeing the data associated with a callback.
The \f(CW$ff\fR and \f(CW$opaque\fR parameters are the callback and data
registered for the handle/timeout.
.ie n .IP "my $watch = Sys::Virt::Event::add_handle($fd, $events, $coderef)" 4
.el .IP "my \f(CW$watch\fR = Sys::Virt::Event::add_handle($fd, \f(CW$events\fR, \f(CW$coderef\fR)" 4
.IX Item "my $watch = Sys::Virt::Event::add_handle($fd, $events, $coderef)"
Adds a watch on the file descriptor \f(CW$fd\fR for the events \f(CW$events\fR
which is a mask of the \s-1FILE HANDLE EVENTS\s0 constants listed later.
The \f(CW$coderef\fR parameter is a subroutine to invoke when an event
is triggered. The subroutine will be passed three parameters, the
watch identifier, the file descriptor and the event mask. This
method returns the watch identifier which can be used to update or
remove the watch
.ie n .IP "Sys::Virt::Event::update_handle($watch, $events)" 4
.el .IP "Sys::Virt::Event::update_handle($watch, \f(CW$events\fR)" 4
.IX Item "Sys::Virt::Event::update_handle($watch, $events)"
Update the event mask for the file descriptor watch \f(CW$watch\fR
to use the events \f(CW$events\fR.
.IP "Sys::Virt::Event::remove_handle($watch)" 4
.IX Item "Sys::Virt::Event::remove_handle($watch)"
Remove the event mask for the file descriptor watch \f(CW$watch\fR.
.ie n .IP "my $watch = Sys::Virt::Event::add_timeout($frequency, $coderef)" 4
.el .IP "my \f(CW$watch\fR = Sys::Virt::Event::add_timeout($frequency, \f(CW$coderef\fR)" 4
.IX Item "my $watch = Sys::Virt::Event::add_timeout($frequency, $coderef)"
Adds a timeout to trigger with \f(CW$frequency\fR milliseconds interval.
The \f(CW$coderef\fR parameter is a subroutine to invoke when an event
is triggered. The subroutine will be passed one parameter, the
timer identifier. This method returns the watch identifier which
can be used to update or remove the watch
.ie n .IP "Sys::Virt::Event::update_timeout($timer, $frequency)" 4
.el .IP "Sys::Virt::Event::update_timeout($timer, \f(CW$frequency\fR)" 4
.IX Item "Sys::Virt::Event::update_timeout($timer, $frequency)"
Update the timeout \f(CW$timer\fR to have the frequency \f(CW$frequency\fR
milliseconds.
.IP "Sys::Virt::Event::remove_timeout($timer)" 4
.IX Item "Sys::Virt::Event::remove_timeout($timer)"
Remove the timeout \f(CW$timer\fR
.SH "CONSTANTS"
.IX Header "CONSTANTS"
.SS "\s-1FILE HANDLE EVENTS\s0"
.IX Subsection "FILE HANDLE EVENTS"
When integrating with an event loop the following constants
define the file descriptor events
.IP "Sys::Virt::Event::HANDLE_READABLE" 4
.IX Item "Sys::Virt::Event::HANDLE_READABLE"
The file descriptor has data available for read without blocking
.IP "Sys::Virt::Event::HANDLE_WRITABLE" 4
.IX Item "Sys::Virt::Event::HANDLE_WRITABLE"
The file descriptor has ability to write data without blocking
.IP "Sys::Virt::Event::HANDLE_ERROR" 4
.IX Item "Sys::Virt::Event::HANDLE_ERROR"
An error occurred on the file descriptor
.IP "Sys::Virt::Event::HANDLE_HANGUP" 4
.IX Item "Sys::Virt::Event::HANDLE_HANGUP"
The remote end of the file descriptor closed
.SH "AUTHORS"
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006\-2009 Red Hat
Copyright (C) 2006\-2009 Daniel P. Berrange
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the terms of either the \s-1GNU\s0 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 \s-1README\s0 file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt,  \f(CW\*(C`http://libvirt.org\*(C'\fR