1Test::Reporter::TranspoUrste(r3)Contributed Perl DocumenTteastti:o:nReporter::Transport(3)
2
3
4

NAME

6       Test::Reporter::Transport - base class for Test::Reporter transports
7

VERSION

9       version 1.62
10

SYNOPSIS

12           # Defines API that must be implemented by subclasses
13
14           my $sender = Test::Reporter::Transport::Subclass->new( @args );
15
16           $sender->send( $report )
17

DESCRIPTION

19       Transport subclasses provide the means by which CPAN Testers reports
20       are transmitted to the CPAN Testers mailing list.
21
22       This module is an abstract base class that define an API for
23       Test::Reporter::Transport subclasses.  Individual subclasses MUST
24       implement the methods described below.
25

USAGE

27       A transport method is specified to Test::Reporter using the "transport"
28       option.  The "transport" option expects just the module "suffix" that
29       follows "Test::Reporter::Transport".  For example:
30
31           # use Test::Reporter::Transport::Null for transport
32           my $report = Test::Reporter->new(
33               transport => 'Null'
34           );
35
36       Configuration of the transport is specified with the "transport_args"
37       option:
38
39           my $report = Test::Reporter->new(
40               transport => 'File',
41               transport_args => [ dir => '/tmp' ],
42           );
43
44       These may also be specified with the "transport" or "transport_args"
45       methods:
46
47           $report->transport_args( dir => '/tmp' );
48
49       These may also be combined in the "transport" method itself:
50
51           $report->transport( 'File', dir => '/tmp' );
52

METHODS

54       The terms 'may', 'must', 'should', etc. used below have their usual RFC
55       meanings.
56
57   new
58           my $sender = $subclass->new( @args );
59
60       The "new" method is the object constructor.  It MAY take a list of any
61       necessary configuration options.  It MUST return a transport object if
62       one is successfully created or undef if the object can not be created.
63
64   send
65           $sender->send( $report );
66
67       The "send" method MUST take a Test::Reporter object as its only
68       argument.  It MUST return true if the report is successfully sent.  It
69       SHOULD die with a message describing the failure if a report cannot be
70       sent.  It MUST NOT return a true value if the report cannot be sent.
71

AUTHORS

73       •   Adam J. Foxson <afoxson@pobox.com>
74
75       •   David Golden <dagolden@cpan.org>
76
77       •   Kirrily "Skud" Robert <skud@cpan.org>
78
79       •   Ricardo Signes <rjbs@cpan.org>
80
81       •   Richard Soderberg <rsod@cpan.org>
82
83       •   Kurt Starsinic <Kurt.Starsinic@isinet.com>
84

86       This software is copyright (c) 2015 by Authors and Contributors.
87
88       This is free software; you can redistribute it and/or modify it under
89       the same terms as the Perl 5 programming language system itself.
90
91
92
93perl v5.38.0                      2023-07-21      Test::Reporter::Transport(3)
Impressum