Test::AutoBuild::Monitor::Pipe(3pm)

1Test::AutoBuild::MonitoUrs:e:rPiCpoen(t3r)ibuted Perl DoTceusmte:n:tAauttiooBnuild::Monitor::Pipe(3)
2
3
4

NAME

6       Test::AutoBuild::Monitor::Pipe - Monitor progress through a pipe
7

SYNOPSIS

9         use Test::AutoBuild::Monitor::Pipe
10
11         my $monitor = Test::AutoBuild::Pipe->new(
12                             options => {
13                               path => "/var/lib/builder/monitor",
14                               mode = 0644
15                             },
16                             env => \%env);
17
18         # Emit some events
19         $monitor->notify("begin-stage", "build", time);
20         $monitor->notify("end-stage", "build", time, $status);
21

DESCRIPTION

23       This module sends events down a pipe, one line per event. The data is
24       formatted in the scheme:
25
26          begin-stage('build', '12450052')
27          end-stage('build', '12452345', 'failed')
28

CONFIGURATION

30       Along with the standard configuration parameters for
31       "Test::AutoBuild::Monitor", this module expects two options to be set:
32
33       path
34           The full path to the FIFO pipe. The pipe will be created if it does
35           not already exist
36
37       mask
38           The permissions mask to use when creating the file, in decimal, not
39           octal. Defaults to 493, which is 0755 in octal, if not specified.
40
41   EXAMPLE
42         pipe = {
43           label = FIFO monitor
44           module = Test::AutoBuild::Monitor::Pipe
45           options = {
46             path = /var/lib/builder/monitor
47             # 0755 in decimal
48             mask = 493
49           }
50         }
51

METHODS

53       $monitor->init(%params);
54           This method initializes a new monitor & is called automatically by
55           the "new" method. The %params parameters are passed through from
56           the "new" method.
57
58       $monitor->process($event_name, @args);
59           This method writes the event to the FIFO pipe and flushes the
60           output stream
61

AUTHORS

63       Daniel Berrange <dan@berrange.com>
64

COPYRIGHT

66       Copyright (C) 2005 Daniel Berrange <dan@berrange.com>
67