Luis Muñoz > DNS-BL-0.03 > DNS::BL::cmds

Download:
DNS-BL-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.00_01   Source  

NAME ^

DNS::BL::cmds - Base class for DNS::BL commands

SYNOPSIS ^

  use DNS::BL::cmds;

DESCRIPTION ^

This module provides template functions that must be overriden by the actual DNS::BL commands, as well as its documentation. This behaves as a pure-virtual class.

The following methods are implemented by this module:

->execute($dns_bl, $verb, @arguments)

This method is invoked by DNS::BL whenever parsing of a command line with a given verb is requested. The first argument, is a reference to the invoking DNS::BL object. The second argument is the verb that caused this invocation. Any additional parameters, are passed along as a list or arguments.

In scalar context, this method must return one of the DNSBL_* constants defined in DNS::BL. In list context, the first element of the return value must be this constant. The second argument, must be an explanation message suitable for presenting to an end user.

->arg_check($caller, $dns_bl, $handler, $verb, \@known, \%arguments)

This method is provided as a courtesy to subclasses. It tests automatically wether passed arguments are understood by the implementation. See the various subclasses for examples of its use.

EXPORT

None by default.

HISTORY ^

0.00_01

Original version; created by h2xs 1.22

SEE ALSO ^

Perl(1), DNS::BL.

AUTHOR ^

Luis Muñoz, <luismunoz@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2004 by Luis Muñoz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: