Difference between revisions of "API:EPrints/Bench"

From EPrints Documentation
Jump to: navigation, search
(3 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==NAME==
 
==NAME==
EPrints::Bench
+
'''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%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 17: Line 17:
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
Tools for benchmarking performance of EPrinst Repository software.
+
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%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 35: Line 35:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
<!-- Pod2Wiki=item_eprints_bench_clear -->
+
<!-- Pod2Wiki=item_clear -->
===eprints_bench_clear===
+
===clear===
  
  EPrints::Bench::clear
+
  EPrints::Bench::clear()
Empties @ids array and $totals and $starts hash references. (So a new benchmarking task can be undertaken).
+
Empties @ids array and $totals and $starts 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%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 48: Line 48:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
<!-- Pod2Wiki=item_eprints_banch_hitime -->
+
<!-- Pod2Wiki=item_hitime -->
===eprints_banch_hitime===
+
===hitime===
  
  EPrints::Banch::hitime
+
  EPrints::Banch::hitime()
 
Returns an integer representing the number of microseconds since the  start of the epoch.
 
Returns an integer representing the number of microseconds since the  start of the epoch.
  
Line 87: Line 87:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
<!-- Pod2Wiki=item_eprints_bench_totals -->
+
<!-- Pod2Wiki=item_totals -->
===eprints_bench_totals===
+
===totals===
  
  EPrints::Bench::totals
+
  EPrints::Bench::totals()
Print the individual microseconds for each task carried out since  benchmarking was started or last cleared.
+
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%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Revision as of 09:58, 20 December 2021

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Bench - Class for benchmarking EPrints.

User Comments


DESCRIPTION

Tools for benchmarking performance of EPrints Repository software.

User Comments


METHODS

User Comments


clear

EPrints::Bench::clear()

Empties @ids array and $totals and $starts hash references. (So a new set of benchmarking task can be undertaken).

User Comments


hitime

EPrints::Banch::hitime()

Returns an integer representing the number of microseconds since the start of the epoch.

User Comments


enter

EPrints::Bench::enter( $id )

Sets the (microseconds since start of epoch) start time for specified task with $id.

User Comments


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.

User Comments


totals

EPrints::Bench::totals()

Prints the individual microseconds for each task carried out since benchmarking was started or last cleared.

User Comments


COPYRIGHT

© Copyright 2022 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/.

User Comments