NAME

Net::SinFP3::Input - base class for Input plugin objects

SYNOPSIS

use base qw(Net::SinFP3::Input);

# Your Input plugin code

DESCRIPTION

This is the base class for all Net::SinFP3::Input plugins.

ATTRIBUTES

global (Net::SinFP3::Global)

The global object containing global parameters and pointers to currently executing plugins.

last ($scalar)

When set to true value, the next call to run method will return undef. This means the plugin has nothing more to process and can stop.

nextList ([ @array ])

This is mainly used internally when an init method is able to fill a list of next data to process.

METHODS

new (%hash)

Object constructor. You must give it the following attributes: global.

init ()

Do some initialization by writing this method.

run ()

To use when you are ready to launch the main loop.

postRun ()

Method will be run within the jobbed process (after fork or equivalent).

post ()

Do some cleanup by writing this method. post is run at the very end of main Net::SinFP3 loop postlude. The exact order is:

output->post > search->post > mode->post > db->post > input->post

postFork ()

Method will be run in the parent jobbed process (after fork or equivalent).

AUTHOR

Patrice <GomoR> Auffret

COPYRIGHT AND LICENSE

Copyright (c) 2011-2012, Patrice <GomoR> Auffret

You may distribute this module under the terms of the Artistic license. See LICENSE.Artistic file in the source distribution archive.