.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" 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" '' '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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "Test::Reporter::Transport 3pm" .TH Test::Reporter::Transport 3pm "2011-07-19" "perl v5.12.4" "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" Test::Reporter::Transport \- base class for Test::Reporter transports .SH "VERSION" .IX Header "VERSION" version 1.58 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # Defines API that must be implemented by subclasses \& \& my $sender = Test::Reporter::Transport::Subclass\->new( @args ); \& \& $sender\->send( $report ) .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Transport subclasses provide the means by which \s-1CPAN\s0 Testers reports are transmitted to the \s-1CPAN\s0 Testers mailing list. .PP This module is an abstract base class that define an \s-1API\s0 for Test::Reporter::Transport subclasses. Individual subclasses \s-1MUST\s0 implement the methods described below. .SH "USAGE" .IX Header "USAGE" A transport method is specified to Test::Reporter using the \f(CW\*(C`transport\*(C'\fR option. The \f(CW\*(C`transport\*(C'\fR option expects just the module \*(L"suffix\*(R" that follows \&\f(CW\*(C`Test::Reporter::Transport\*(C'\fR. For example: .PP .Vb 4 \& # use Test::Reporter::Transport::Null for transport \& my $report = Test::Reporter\->new( \& transport => \*(AqNull\*(Aq \& ); .Ve .PP Configuration of the transport is specified with the \f(CW\*(C`transport_args\*(C'\fR option: .PP .Vb 4 \& my $report = Test::Reporter\->new( \& transport => \*(AqFile\*(Aq, \& transport_args => [ dir => \*(Aq/tmp\*(Aq ], \& ); .Ve .PP These may also be specified with the \f(CW\*(C`transport\*(C'\fR or \f(CW\*(C`transport_args\*(C'\fR methods: .PP .Vb 1 \& $report\->transport_args( dir => \*(Aq/tmp\*(Aq ); .Ve .PP These may also be combined in the \f(CW\*(C`transport\*(C'\fR method itself: .PP .Vb 1 \& $report\->transport( \*(AqFile\*(Aq, dir => \*(Aq/tmp\*(Aq ); .Ve .SH "METHODS" .IX Header "METHODS" The terms 'may', 'must', 'should', etc. used below have their usual \s-1RFC\s0 meanings. .SS "new" .IX Subsection "new" .Vb 1 \& my $sender = $subclass\->new( @args ); .Ve .PP The \f(CW\*(C`new\*(C'\fR method is the object constructor. It \s-1MAY\s0 take a list of any necessary configuration options. It \s-1MUST\s0 return a transport object if one is successfully created or undef if the object can not be created. .SS "send" .IX Subsection "send" .Vb 1 \& $sender\->send( $report ); .Ve .PP The \f(CW\*(C`send\*(C'\fR method \s-1MUST\s0 take a Test::Reporter object as its only argument. It \&\s-1MUST\s0 return true if the report is successfully sent. It \s-1SHOULD\s0 die with a message describing the failure if a report cannot be sent. It \s-1MUST\s0 \s-1NOT\s0 return a true value if the report cannot be sent. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Adam J. Foxson .IP "\(bu" 4 David Golden .IP "\(bu" 4 Kirrily \*(L"Skud\*(R" Robert .IP "\(bu" 4 Ricardo Signes .IP "\(bu" 4 Richard Soderberg .IP "\(bu" 4 Kurt Starsinic .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2011 by Authors and Contributors. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.