aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVíctor Moral <victor@venexma.es>2014-01-23 14:54:52 +0100
committerVíctor Moral <victor@venexma.es>2014-01-23 14:54:52 +0100
commitdbe1a88e2e6d3543e33258cfaa854180d97a406c (patch)
tree166163bd7cc7e4605ee352e7390a6d1eb3a441cc
parenta876d85021a5468e526e57aaf5e8688b74c08e28 (diff)
downloadcdt-dbe1a88e2e6d3543e33258cfaa854180d97a406c.tar.gz
cdt-dbe1a88e2e6d3543e33258cfaa854180d97a406c.tar.bz2
cdt-dbe1a88e2e6d3543e33258cfaa854180d97a406c.zip
- Comenzamos a añadir documentación a CDT::Queue
-rw-r--r--lib/CDT/Queue.pm91
1 files changed, 91 insertions, 0 deletions
diff --git a/lib/CDT/Queue.pm b/lib/CDT/Queue.pm
index 13eaea9..a889185 100644
--- a/lib/CDT/Queue.pm
+++ b/lib/CDT/Queue.pm
@@ -54,4 +54,95 @@ __PACKAGE__->meta->make_immutable;
1;
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+CDT::Queue - Mantenimiento de colas de archivos
+
+=head1 SYNOPSIS
+
+ use CDT::Queue;
+
+ my $q = CDT::Queue->new( base => q(/var/spool/myapp/queue) );
+
+ #
+ # Differents sources from enqueue a new file
+ #
+ # Reading from standard input
+ $q->enq( \*STDIN );
+
+ # Reading from a file
+ $q->enq( "/var/lib/data/archive.txt" );
+
+ # Reading from a escalar
+ $q->enq( \"This is a new message" );
+
+
+=head1 DESCRIPTION
+
+Este módulo gestiona una cola de archivos
+
+=head1 CONSTRUCTOR
+
+Definition of the new method or similar way of build a class instance.
+
+=head1 ATTRIBUTES/ROLES
+
+A separate section listing the class attributes or roles.
+
+=head1 SUBROUTINES/METHODS
+
+A separate section listing the public components of the
+module's interface.
+
+=head1 DIAGNOSTICS
+
+La clase genera las siguientes excepciones.
+|
+La clase no genera ninguna excepción per se pero pueden aparecer en aquellos
+módulos que emplee.
+
+=head1 CONFIGURATION AND ENVIRONMENT
+
+La clase no precisa de archivos de configuración ni disposiciones especiales
+en el entorno.
+|
+La clase utiliza los siguientes valores de configuración y variables de
+entorno:
+
+=head1 DEPENDENCIES
+
+=over
+
+=item Moose
+
+=back
+
+=head1 INCOMPATIBILITIES
+
+No hay ninguna incompatibilidad reconocida.
+
+=head1 BUGS AND LIMITATIONS
+
+No hay actualmente errores conocidos.
+
+=head1 AUTHOR
+
+Victor Moral <victor@venexma.net>
+
+=head1 LICENSE AND COPYRIGHT
+
+Copyright (c) 2013 <Venexma Europa, S.L.>. All rights reserved.
+
+This module is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself. See L<perlartistic>.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.