Documents update for version 5.3

Signed-off-by: Keshava Munegowda <[email protected]>
kmgowda · Aug 24, 2024 · e331690 · e331690
1 parent 3640530
commit e331690
Show file tree

Hide file tree

Showing 345 changed files with 1,041 additions and 455 deletions.
diff --git a/perl/javadoc/allclasses-index.html b/perl/javadoc/allclasses-index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Classes and Interfaces (perl 5.2 API)</title>
+<title>All Classes and Interfaces (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="class index">
@@ -165,10 +165,14 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
 <div class="block">Interface PerformanceLogger.</div>
 </div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/impl/PerformanceRecorder.html" title="class in io.perl.api.impl">PerformanceRecorder</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Class for Performance Recording.</div>
 </div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/perl/api/PeriodicRecorder.html" title="interface in io.perl.api">PeriodicRecorder</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
 <div class="block">Interface for recording latencies.</div>

diff --git a/perl/javadoc/allpackages-index.html b/perl/javadoc/allpackages-index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Packages (perl 5.2 API)</title>
+<title>All Packages (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="package index">

diff --git a/perl/javadoc/constant-values.html b/perl/javadoc/constant-values.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Constant Field Values (perl 5.2 API)</title>
+<title>Constant Field Values (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="summary of constants">

diff --git a/perl/javadoc/help-doc.html b/perl/javadoc/help-doc.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>API Help (perl 5.2 API)</title>
+<title>API Help (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="help">

diff --git a/perl/javadoc/index-all.html b/perl/javadoc/index-all.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Index (perl 5.2 API)</title>
+<title>Index (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="index">
@@ -146,6 +146,8 @@ <h2 class="title" id="I:C">C</h2>
 <dd>
 <div class="block">Interface Channel.</div>
 </dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#channels" class="member-name-link">channels</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/perl/api/impl/TotalLatencyRecordWindow.html#checkTotalWindowFullAndReset(long)" class="member-name-link">checkTotalWindowFullAndReset(long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/TotalLatencyRecordWindow.html" title="class in io.perl.api.impl">TotalLatencyRecordWindow</a></dt>
 <dd>
 <div class="block">This method checks if totalWindow is full and Stop the Total Window.</div>
@@ -855,14 +857,28 @@ <h2 class="title" id="I:P">P</h2>
 <dd>
 <div class="block">Interface PerformanceLogger.</div>
 </dd>
-<dt><a href="io/perl/api/impl/PerformanceRecorder.html" class="type-name-link" title="class in io.perl.api.impl">PerformanceRecorder</a> - Class in <a href="io/perl/api/impl/package-summary.html">io.perl.api.impl</a></dt>
+<dt><a href="io/perl/api/PerformanceRecorder.html" class="type-name-link" title="class in io.perl.api">PerformanceRecorder</a> - Class in <a href="io/perl/api/package-summary.html">io.perl.api</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int)" class="member-name-link">PerformanceRecorder(PeriodicRecorder, Channel[], Time, int)</a> - Constructor for class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>
+<div class="block">Constructor to initialize values.</div>
+</dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" class="type-name-link" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a> - Class in <a href="io/perl/api/impl/package-summary.html">io.perl.api.impl</a></dt>
 <dd>
 <div class="block">Class for Performance Recording.</div>
 </dd>
-<dt><a href="io/perl/api/impl/PerformanceRecorder.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int,int)" class="member-name-link">PerformanceRecorder(PeriodicRecorder, Channel[], Time, int, int)</a> - Constructor for class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorder.html" title="class in io.perl.api.impl">PerformanceRecorder</a></dt>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int,int)" class="member-name-link">PerformanceRecorderIdleBusyWait(PeriodicRecorder, Channel[], Time, int, int)</a> - Constructor for class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a></dt>
 <dd>
 <div class="block">Constructor to initialize values.</div>
 </dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" class="type-name-link" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a> - Class in <a href="io/perl/api/impl/package-summary.html">io.perl.api.impl</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int,int)" class="member-name-link">PerformanceRecorderIdleSleep(PeriodicRecorder, Channel[], Time, int, int)</a> - Constructor for class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a></dt>
+<dd>
+<div class="block">Constructor to initialize values.</div>
+</dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#periodicRecorder" class="member-name-link">periodicRecorder</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/perl/api/PeriodicRecorder.html" class="type-name-link" title="interface in io.perl.api">PeriodicRecorder</a> - Interface in <a href="io/perl/api/package-summary.html">io.perl.api</a></dt>
 <dd>
 <div class="block">Interface for recording latencies.</div>
@@ -1109,7 +1125,15 @@ <h2 class="title" id="I:R">R</h2>
 <dd>
 <div class="block">Run the CQ Perl.</div>
 </dd>
-<dt><a href="io/perl/api/impl/PerformanceRecorder.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorder.html" title="class in io.perl.api.impl">PerformanceRecorder</a></dt>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a></dt>
+<dd>
+<div class="block">Method run.</div>
+</dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a></dt>
+<dd>
+<div class="block">Method run.</div>
+</dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
 <dd>
 <div class="block">Method run.</div>
 </dd>
@@ -1158,6 +1182,10 @@ <h2 class="title" id="I:S">S</h2>
 <dd>
 <div class="block"><code>String slc2Name</code>.</div>
 </dd>
+<dt><a href="io/perl/config/PerlConfig.html#sleepMS" class="member-name-link">sleepMS</a> - Variable in class io.perl.config.<a href="io/perl/config/PerlConfig.html" title="class in io.perl.config">PerlConfig</a></dt>
+<dd>
+<div class="block"><code>int sleepMS</code>.</div>
+</dd>
 <dt><a href="io/perl/logger/impl/DefaultPrometheusLogger.html#start()" class="member-name-link">start()</a> - Method in class io.perl.logger.impl.<a href="io/perl/logger/impl/DefaultPrometheusLogger.html" title="class in io.perl.logger.impl">DefaultPrometheusLogger</a></dt>
 <dd>
 <div class="block">Starts this server in a new background thread.</div>
@@ -1240,6 +1268,8 @@ <h2 class="title" id="I:T">T</h2>
 <dd>
 <div class="block"><code>Time time</code>.</div>
 </dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#time" class="member-name-link">time</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/time/Time.html" class="type-name-link" title="interface in io.time">Time</a> - Interface in <a href="io/time/package-summary.html">io.time</a></dt>
 <dd>
 <div class="block">Interface Time.</div>
@@ -1389,6 +1419,8 @@ <h2 class="title" id="I:W">W</h2>
 <dd>
 <div class="block"><code>LatencyRecordWindow window</code>.</div>
 </dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#windowIntervalMS" class="member-name-link">windowIntervalMS</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/perl/api/impl/TotalLatencyRecordWindow.html#windowLogger" class="member-name-link">windowLogger</a> - Variable in class io.perl.api.impl.<a href="io/perl/api/impl/TotalLatencyRecordWindow.html" title="class in io.perl.api.impl">TotalLatencyRecordWindow</a></dt>
 <dd>
 <div class="block"><code>Print windowLogger</code>.</div>

diff --git a/perl/javadoc/index.html b/perl/javadoc/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Overview (perl 5.2 API)</title>
+<title>Overview (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="package index">
@@ -47,7 +47,7 @@
 <div class="flex-content">
 <main role="main">
 <div class="header">
-<h1 class="title">perl 5.2 API</h1>
+<h1 class="title">perl 5.3 API</h1>
 </div>
 <div id="all-packages-table">
 <div class="caption"><span>Packages</span></div>

diff --git a/perl/javadoc/io/perl/api/Channel.html b/perl/javadoc/io/perl/api/Channel.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Channel (perl 5.2 API)</title>
+<title>Channel (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, interface: Channel">

diff --git a/perl/javadoc/io/perl/api/GetPerlChannel.html b/perl/javadoc/io/perl/api/GetPerlChannel.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>GetPerlChannel (perl 5.2 API)</title>
+<title>GetPerlChannel (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, interface: GetPerlChannel">

diff --git a/perl/javadoc/io/perl/api/LatencyPercentiles.html b/perl/javadoc/io/perl/api/LatencyPercentiles.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyPercentiles (perl 5.2 API)</title>
+<title>LatencyPercentiles (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyPercentiles">

diff --git a/perl/javadoc/io/perl/api/LatencyRecord.html b/perl/javadoc/io/perl/api/LatencyRecord.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyRecord (perl 5.2 API)</title>
+<title>LatencyRecord (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyRecord">

diff --git a/perl/javadoc/io/perl/api/LatencyRecordWindow.html b/perl/javadoc/io/perl/api/LatencyRecordWindow.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyRecordWindow (perl 5.2 API)</title>
+<title>LatencyRecordWindow (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyRecordWindow">

diff --git a/perl/javadoc/io/perl/api/LatencyRecorder.html b/perl/javadoc/io/perl/api/LatencyRecorder.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyRecorder (perl 5.2 API)</title>
+<title>LatencyRecorder (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyRecorder">

diff --git a/perl/javadoc/io/perl/api/LatencyWindow.html b/perl/javadoc/io/perl/api/LatencyWindow.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyWindow (perl 5.2 API)</title>
+<title>LatencyWindow (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyWindow">