cPanel::MemTest

cPanel::MemTest(3)   User Contributed Perl Documentation   cPanel::MemTest(3)



NAME
       cPanel::MemTest - Test Memory Allocation

VERSION
       This document describes cPanel::MemTest version 0.0.2

SYNOPSIS
	   use cPanel::MemTest;

	   my $megs_to_allocate = 200;
	   my $megs_allocated	= cPanel::MemTest::testallocate( $megs_to_allocate );
	   die ’There was a problem allocating memory’ if $megs_allocated != $megs_to_allocate;

DESCRIPTION
       If you know you’ll be running a memory intensive script it can be nice
       to be able to see if there is enough memory first instead of hitting a
       memory limit partway through and failing with little or no control
       over it.

INTERFACE
       testallocate()

       This exportable function takes one argument: the number of megabytes
       to try and allocate betwen 1 and 1024

       It returns the number of allocated megabytes.

       If they are not the same then the allocation had issues ( see SYNOPSIS
       )

DIAGNOSTICS
       "Unable to allocate %d Megabytes of memory (Invalid Argument)"
	   Invalid argument was passed to testallocate() (IE it is not 1 ..
	   1024)

       "Error while allocating memory! %d Megabytes already allocated"
	   There was not enough free memory left to allocate the amount you
	   requested.

CONFIGURATION AND ENVIRONMENT
       cPanel::MemTest requires no configuration files or environment vari-
       ables.

DEPENDENCIES
       None.

INCOMPATIBILITIES
       None reported.

BUGS AND LIMITATIONS
       No bugs have been reported.

       Please report any bugs or feature requests to
       "bug-cpanel-memtest@rt.cpan.org", or through the web interface at
       <http://rt.cpan.org>.

SEE ALSO
       Semi related to this topic is limiting memory via BSD::Resource

AUTHOR
       Daniel Muey  "<http://drmuey.com/cpan_contact.pl>"

LICENCE AND COPYRIGHT
       Copyright (c) 2007, cPanel, Inc. All rights reserved.

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

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
       PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
       SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME
       THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING REN-
       DERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.



perl v5.8.8			  2007-10-05		   cPanel::MemTest(3)