/[webpac2]/trunk/lib/WebPAC/Input.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/WebPAC/Input.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1 by dpavlin, Sat Jun 25 20:23:23 2005 UTC revision 3 by dpavlin, Sat Jul 16 11:07:38 2005 UTC
# Line 5  use strict; Line 5  use strict;
5    
6  =head1 NAME  =head1 NAME
7    
8  WebPAC::Input - The great new WebPAC::Input!  WebPAC::Input - core module for input file format
9    
10  =head1 VERSION  =head1 VERSION
11    
# Line 17  our $VERSION = '0.01'; Line 17  our $VERSION = '0.01';
17    
18  =head1 SYNOPSIS  =head1 SYNOPSIS
19    
20  Quick summary of what the module does.  This module will load particular loader module and execute it's functions.
21    
22  Perhaps a little code snippet.  Perhaps a little code snippet.
23    
24      use WebPAC::Input;      use WebPAC::Input;
25    
26      my $foo = WebPAC::Input->new();      my $db = WebPAC::Input->new(
27      ...          format => 'NULL',
28            config => $config,
29        );
30    
31        $db->open('/path/to/database');
32        print "database size: ",$db->size,"\n";
33        while (my $row = $db->fetch) {
34            ...
35        }
36        $db->close;
37    
38  =head1 EXPORT  =head1 FUNCTIONS
39    
40  A list of functions that can be exported.  You can delete this section  =head2 new
 if you don't export anything, such as for a purely object-oriented module.  
41    
42  =head1 FUNCTIONS  Create new input database object.
43    
44  =head2 function1    my $db = new WebPAC::Input( format => 'NULL' );
45    
46    This function will load needed wrapper module and
47    
48  =cut  =cut
49    
50  sub function1 {  sub new {
51            my $class = shift;
52            my $self = {@_};
53            bless($self, $class);
54    
55            $self ? return $self : return undef;
56    }
57    
58    =head2 open
59    
60    =cut
61    
62    sub open {
63  }  }
64    
65  =head2 function2  =head2 function2
# Line 47  sub function1 { Line 69  sub function1 {
69  sub function2 {  sub function2 {
70  }  }
71    
 =head1 AUTHOR  
72    
 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  
73    
74  =head1 BUGS  =head1 MEMORY USAGE
75    
76    C<low_mem> options is double-edged sword. If enabled, WebPAC
77    will run on memory constraint machines (which doesn't have enough
78    physical RAM to create memory structure for whole source database).
79    
80    If your machine has 512Mb or more of RAM and database is around 10000 records,
81    memory shouldn't be an issue. If you don't have enough physical RAM, you
82    might consider using virtual memory (if your operating system is handling it
83    well, like on FreeBSD or Linux) instead of dropping to L<DBM::Deep> to handle
84    parsed structure of ISIS database (this is what C<low_mem> option does).
85    
86    Hitting swap at end of reading source database is probably o.k. However,
87    hitting swap before 90% will dramatically decrease performance and you will
88    be better off with C<low_mem> and using rest of availble memory for
89    operating system disk cache (Linux is particuallary good about this).
90    However, every access to database record will require disk access, so
91    generation phase will be slower 10-100 times.
92    
93    Parsed structures are essential - you just have option to trade RAM memory
94    (which is fast) for disk space (which is slow). Be sure to have planty of
95    disk space if you are using C<low_mem> and thus L<DBM::Deep>.
96    
97    However, when WebPAC is running on desktop machines (or laptops :-), it's
98    highly undesireable for system to start swapping. Using C<low_mem> option can
99    reduce WecPAC memory usage to around 64Mb for same database with lookup
100    fields and sorted indexes which stay in RAM. Performance will suffer, but
101    memory usage will really be minimal. It might be also more confortable to
102    run WebPAC reniced on those machines.
103    
 Please report any bugs or feature requests to  
 C<bug-webpac-input@rt.cpan.org>, or through the web interface at  
 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebPAC>.  
 I will be notified, and then you'll automatically be notified of progress on  
 your bug as I make changes.  
104    
105  =head1 ACKNOWLEDGEMENTS  =head1 AUTHOR
106    
107    Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>
108    
109  =head1 COPYRIGHT & LICENSE  =head1 COPYRIGHT & LICENSE
110    
Legend:
Removed from v.1  
changed lines
  Added in v.3
  ViewVC Help
Powered by ViewVC 1.1.26