Difference between revisions of "API:EPrints/Bench"
m (adding Category:Rubbish) |
|||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category: | + | <!-- Pod2Wiki=_preamble_ |
| + | This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | ||
| + | -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Bench.pm|package_name=EPrints::Bench}}[[Category:API|BENCH]]<div><!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | ||
| + | ==NAME== | ||
| + | '''EPrints::Bench''' - Class for benchmarking EPrints. | ||
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=head_description --> | ||
| + | ==DESCRIPTION== | ||
| + | Tools for benchmarking performance of EPrints Repository software. | ||
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=head_methods --> | ||
| + | ==METHODS== | ||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_clear --> | ||
| + | ===clear=== | ||
| + | |||
| + | EPrints::Bench::clear() | ||
| + | Empties <tt>@ids</tt> array and <tt>$totals</tt> and <tt>$starts</tt> hash references. (So a new set of benchmarking task can be undertaken). | ||
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_hitime --> | ||
| + | ===hitime=== | ||
| + | |||
| + | EPrints::Banch::hitime() | ||
| + | Returns an integer representing the number of microseconds since the start of the epoch. | ||
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_enter --> | ||
| + | ===enter=== | ||
| + | |||
| + | EPrints::Bench::enter( $id ) | ||
| + | Sets the (microseconds since start of epoch) start time for specified task with <tt>$id</tt>. | ||
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_leave --> | ||
| + | ===leave=== | ||
| + | |||
| + | EPrints::Bench::leave( $id ) | ||
| + | Sets the total time (in microseconds) for a specified task with <tt>$id</tt> based on the time since that set for same ID by [[API:EPrints/Bench#enter|EPrints::Bench::enter]]. | ||
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_totals --> | ||
| + | ===totals=== | ||
| + | |||
| + | EPrints::Bench::totals() | ||
| + | Prints the individual microseconds for each task carried out since benchmarking was started or last cleared. | ||
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=head_copyright --> | ||
| + | ==COPYRIGHT== | ||
| + | {{API:Copyright}} | ||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> | ||
Latest revision as of 10:43, 4 March 2022
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::Bench - Class for benchmarking EPrints.
DESCRIPTION
Tools for benchmarking performance of EPrints Repository software.
METHODS
clear
EPrints::Bench::clear()
Empties @ids array and $totals and $starts hash references. (So a new set of benchmarking task can be undertaken).
hitime
EPrints::Banch::hitime()
Returns an integer representing the number of microseconds since the start of the epoch.
enter
EPrints::Bench::enter( $id )
Sets the (microseconds since start of epoch) start time for specified task with $id.
leave
EPrints::Bench::leave( $id )
Sets the total time (in microseconds) for a specified task with $id based on the time since that set for same ID by EPrints::Bench::enter.
totals
EPrints::Bench::totals()
Prints the individual microseconds for each task carried out since benchmarking was started or last cleared.
COPYRIGHT
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 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. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.
