Lire::Program3pm

Usage

    use Lire::Program qw/ :msg /;
    lr_info( "doing stuff " );
    lr_debug( "debugging information" );
    lr_warn( "encountered unexpected value: ", $value );
    open( CFGFILE, "my.conf" ) or lr_err( "open error: ", $! );

Overview

This module should be used by all Lire programs (at least the Perl ones :-).

It includes:

1.

Common behavior for good integration in the Lire suite. (Output of performance information and other stuff).

2.

Functions for portability.

3.

Logging functions

Common behavior for lire programs

When you use the Lire::Program module, you make sure that your program will behave correctly in the Lire tool chain. This module will install BEGIN and END blocks to comply with Lire's policy.

1.

Only messages in the proper logging format

    I<superservice> I<service> I<lr_id> I<program> I<level> I<msg>

should be output. This module will install a __WARN__ signal handler that makes sure that all modules that use warn to output messages are rewritten in the proper format.

See also lr_run(1).

2.

All programs should start by a "info" message which logs their arguments. This module takes care of this.

3.

All programs should end by printing "info" messages with performance statistics and the message 'ended'. Using this module takes care of this. At the end of your program the following will be output (stripped off the common information):

    memory stats: vsize=10688K rss=9380K majflt=406
    elapsed time in seconds real=9 user=8.72 system=0.06
    stopped

The memory profiling information will only be output on platforms running the Linux kernel.

Logging functions

The logging functions are now part of the Lire::Logger module. Consult Lire::Logger(3pm) for more information. The old names are still exported from this module by using the ':msg' tag.

DLF converters functions

The DLF converter API is now defined in Lire::DlfConverter(3pm). The Lire::OldDlfAdapter(3pm) can be used to work with old-style DLF Converters.

Version

$Id: Program.pm,v 1.35 2006/07/23 13:16:29 vanbaal Exp $