.\" Automatically generated by Pod::Man 2.27 (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 "Linux::IO_Prio 3pm"
.TH Linux::IO_Prio 3pm "2011-12-12" "perl v5.18.2" "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"
Linux::IO_Prio \- Interface to Linux ioprio_set and ioprio_get via syscall or ionice wrapper.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Linux::IO_Prio qw(:all);
\&
\&        my $status = ioprio_set(IOPRIO_WHO_PROCESS, $$,
\&                IOPRIO_PRIO_VALUE(IOPRIO_CLASS_IDLE, 0));
\&
\&        my $status = ionice(IOPRIO_WHO_PROCESS, $$, IOPRIO_CLASS_IDLE, 0);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Use \fIioprio_get\fR\|(2) and \fIioprio_set\fR\|(2) from Perl.  Only Linux is supported
currently. Support for other unices will be added once the kernel capabilities
are available.
.SH "Exports"
.IX Header "Exports"
Nothing by default.
.PP
The required exports can be specified individually or by tag:
.IP ":ionice \*(-- ionice ionice_data ionice_class" 4
.IX Item ":ionice ionice ionice_data ionice_class"
.PD 0
.IP ":c_api \*(-- ioprio_set ioprio_get" 4
.IX Item ":c_api ioprio_set ioprio_get"
.IP ":macro \*(-- \s-1IOPRIO_PRIO_VALUE IOPRIO_PRIO_CLASS IOPRIO_PRIO_DATA\s0" 4
.IX Item ":macro IOPRIO_PRIO_VALUE IOPRIO_PRIO_CLASS IOPRIO_PRIO_DATA"
.IP ":who \*(-- \s-1IOPRIO_WHO_PROCESS IOPRIO_WHO_PGRP IOPRIO_WHO_USER\s0" 4
.IX Item ":who IOPRIO_WHO_PROCESS IOPRIO_WHO_PGRP IOPRIO_WHO_USER"
.IP ":class \*(-- \s-1IOPRIO_CLASS_NONE IOPRIO_CLASS_RT IOPRIO_CLASS_BE IOPRIO_CLASS_IDLE \s0" 4
.IX Item ":class IOPRIO_CLASS_NONE IOPRIO_CLASS_RT IOPRIO_CLASS_BE IOPRIO_CLASS_IDLE "
.IP ":all \*(-- all the above" 4
.IX Item ":all all the above"
.PD
.PP
\&\fIionice()\fR, \fIionice_class()\fR and \fIionice_data()\fR are thin wrappers around the C \s-1API\s0
allowing conventient single function calls.  All of the other exports have the
same meaning and prototypes as the C \s-1API\s0 equivalents. See man \fIioprio_set\fR\|(2)
for further details.
.SS "Functions"
.IX Subsection "Functions"
\fIC \s-1API\s0\fR
.IX Subsection "C API"
.ie n .IP "$priority = ioprio_get($which, $who)" 4
.el .IP "\f(CW$priority\fR = ioprio_get($which, \f(CW$who\fR)" 4
.IX Item "$priority = ioprio_get($which, $who)"
.PD 0
.ie n .IP "$staus = ioprio_set($which, $who, $priority)" 4
.el .IP "\f(CW$staus\fR = ioprio_set($which, \f(CW$who\fR, \f(CW$priority\fR)" 4
.IX Item "$staus = ioprio_set($which, $who, $priority)"
.PD
.PP
\fIWrappers\fR
.IX Subsection "Wrappers"
.ie n .IP "$status = ionice($which, $who, $class, $data)" 4
.el .IP "\f(CW$status\fR = ionice($which, \f(CW$who\fR, \f(CW$class\fR, \f(CW$data\fR)" 4
.IX Item "$status = ionice($which, $who, $class, $data)"
.PD 0
.ie n .IP "$class = ionice_class($which, $who)" 4
.el .IP "\f(CW$class\fR = ionice_class($which, \f(CW$who\fR)" 4
.IX Item "$class = ionice_class($which, $who)"
.ie n .IP "$data = ionice_data($which, $who)" 4
.el .IP "\f(CW$data\fR = ionice_data($which, \f(CW$who\fR)" 4
.IX Item "$data = ionice_data($which, $who)"
.PD
.SS "\s-1MACROS\s0"
.IX Subsection "MACROS"
.ie n .IP "$priority = \s-1IOPRIO_PRIO_VALUE\s0($class, $data)" 4
.el .IP "\f(CW$priority\fR = \s-1IOPRIO_PRIO_VALUE\s0($class, \f(CW$data\fR)" 4
.IX Item "$priority = IOPRIO_PRIO_VALUE($class, $data)"
.PD 0
.ie n .IP "$class = \s-1IOPRIO_PRIO_CLASS\s0($mask)" 4
.el .IP "\f(CW$class\fR = \s-1IOPRIO_PRIO_CLASS\s0($mask)" 4
.IX Item "$class = IOPRIO_PRIO_CLASS($mask)"
.ie n .IP "$data = \s-1IOPRIO_PRIO_DATA \s0($mask)" 4
.el .IP "\f(CW$data\fR = \s-1IOPRIO_PRIO_DATA \s0($mask)" 4
.IX Item "$data = IOPRIO_PRIO_DATA ($mask)"
.PD
.SS "\s-1CONSTANTS\s0"
.IX Subsection "CONSTANTS"
.IP "\s-1IOPRIO_WHO_PROCESS\s0" 4
.IX Item "IOPRIO_WHO_PROCESS"
.PD 0
.IP "\s-1IOPRIO_WHO_PGRP\s0" 4
.IX Item "IOPRIO_WHO_PGRP"
.IP "\s-1IOPRIO_WHO_USER\s0" 4
.IX Item "IOPRIO_WHO_USER"
.IP "\s-1IOPRIO_CLASS_NONE\s0" 4
.IX Item "IOPRIO_CLASS_NONE"
.IP "\s-1IOPRIO_CLASS_RT\s0" 4
.IX Item "IOPRIO_CLASS_RT"
.IP "\s-1IOPRIO_CLASS_BE\s0" 4
.IX Item "IOPRIO_CLASS_BE"
.IP "\s-1IOPRIO_CLASS_IDLE\s0" 4
.IX Item "IOPRIO_CLASS_IDLE"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This module is Copyright (c) 2011 Mark Hindley
.PP
All rights reserved.
.PP
You may distribute under the terms of either the \s-1GNU\s0 General Public
License or the Artistic License, as specified in the Perl \s-1README\s0 file.
If you need more liberal licensing terms, please contact the
maintainer.
.SH "WARRANTY"
.IX Header "WARRANTY"
This is free software. \s-1IT COMES WITHOUT WARRANTY OF ANY KIND.\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Mark Hindley <mark@hindley.org.uk>