Skip to content

Commit

Permalink
javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@elimelt
elimelt committed Nov 4, 2024
1 parent 0ad155d commit ec1c772
Show file tree
Hide file tree
Showing 82 changed files with 11,844 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/META-INF/MANIFEST.MF
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Manifest-Version: 1.0
Created-By: Maven Javadoc Plugin 3.5.0
Build-Jdk-Spec: 21

126 changes: 126 additions & 0 deletions docs/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Sun Nov 03 18:38:20 PST 2024 -->
<title>All Classes and Interfaces (pmqueue 1.0-SNAPSHOT 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="dc.created" content="2024-11-03">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-classes-index-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-classes">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
</div>
<div id="all-classes-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enums</button></div>
<div id="all-classes-table.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/consumer/DefaultMessageConsumer.html" title="class in io.github.elimelt.pmqueue.consumer">DefaultMessageConsumer</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Default implementation of MessageConsumer.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/producer/DefaultMessageProducer.html" title="class in io.github.elimelt.pmqueue.producer">DefaultMessageProducer</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Default implementation of MessageProducer.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/message/Message.html" title="class in io.github.elimelt.pmqueue.message">Message</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A high-performance, immutable message container optimized for memory
efficiency and fast access.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/elimelt/pmqueue/consumer/MessageConsumer.html" title="interface in io.github.elimelt.pmqueue.consumer">MessageConsumer</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Interface for consuming messages.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/elimelt/pmqueue/producer/MessageProducer.html" title="interface in io.github.elimelt.pmqueue.producer">MessageProducer</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">Interface for sending messages.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/elimelt/pmqueue/MessageQueue.html" title="interface in io.github.elimelt.pmqueue">MessageQueue</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Interface for message queues.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/message/MessageSerializer.html" title="class in io.github.elimelt.pmqueue.message">MessageSerializer</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A high-performance serializer for <a href="io/github/elimelt/pmqueue/message/Message.html" title="class in io.github.elimelt.pmqueue.message"><code>Message</code></a> objects using direct memory
operations.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/core/PersistentMessageQueue.html" title="class in io.github.elimelt.pmqueue.core">PersistentMessageQueue</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A high-performance, persistent queue implementation for storing messages on
disk.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/QueueConfig.html" title="class in io.github.elimelt.pmqueue">QueueConfig</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Configuration for a message queue.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/QueueConfig.Builder.html" title="class in io.github.elimelt.pmqueue">QueueConfig.Builder</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Builder for QueueConfig.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/QueueFactory.html" title="class in io.github.elimelt.pmqueue">QueueFactory</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Factory for creating MessageQueue instances with various configurations.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/elimelt/pmqueue/QueueFactory.CustomQueueBuilder.html" title="class in io.github.elimelt.pmqueue">QueueFactory.CustomQueueBuilder</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Creates a queue with a custom configuration.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="io/github/elimelt/pmqueue/QueueFactory.QueuePreset.html" title="enum in io.github.elimelt.pmqueue">QueueFactory.QueuePreset</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Predefined queue configurations</div>
</div>
</div>
</div>
</div>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
77 changes: 77 additions & 0 deletions docs/allpackages-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Sun Nov 03 18:38:20 PST 2024 -->
<title>All Packages (pmqueue 1.0-SNAPSHOT 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="dc.created" content="2024-11-03">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-packages-index-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-packages">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</div>
<div class="caption"><span>Package Summary</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="io/github/elimelt/pmqueue/package-summary.html">io.github.elimelt.pmqueue</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="io/github/elimelt/pmqueue/consumer/package-summary.html">io.github.elimelt.pmqueue.consumer</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="io/github/elimelt/pmqueue/core/package-summary.html">io.github.elimelt.pmqueue.core</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="io/github/elimelt/pmqueue/message/package-summary.html">io.github.elimelt.pmqueue.message</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="io/github/elimelt/pmqueue/producer/package-summary.html">io.github.elimelt.pmqueue.producer</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
90 changes: 90 additions & 0 deletions docs/constant-values.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Sun Nov 03 18:38:20 PST 2024 -->
<title>Constant Field Values (pmqueue 1.0-SNAPSHOT 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="dc.created" content="2024-11-03">
<meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="constants-summary-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#constant-values">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
</div>
<section class="packages">
<h2 title="Contents">Contents</h2>
<ul class="contents-list">
<li><a href="#io.github">io.github.*</a></li>
</ul>
</section>
<section class="constants-summary" id="io.github">
<h2 title="io.github.*">io.github.*</h2>
<ul class="block-list">
<li>
<div class="caption"><span>io.github.elimelt.pmqueue.core.<a href="io/github/elimelt/pmqueue/core/PersistentMessageQueue.html" title="class in io.github.elimelt.pmqueue.core">PersistentMessageQueue</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="io.github.elimelt.pmqueue.core.PersistentMessageQueue.BLOCK_HEADER_SIZE">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="io/github/elimelt/pmqueue/core/PersistentMessageQueue.html#BLOCK_HEADER_SIZE">BLOCK_HEADER_SIZE</a></code></div>
<div class="col-last even-row-color"><code>8</code></div>
<div class="col-first odd-row-color"><code id="io.github.elimelt.pmqueue.core.PersistentMessageQueue.PAGE_SIZE">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="io/github/elimelt/pmqueue/core/PersistentMessageQueue.html#PAGE_SIZE">PAGE_SIZE</a></code></div>
<div class="col-last odd-row-color"><code>4096</code></div>
<div class="col-first even-row-color"><code id="io.github.elimelt.pmqueue.core.PersistentMessageQueue.QUEUE_HEADER_SIZE">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="io/github/elimelt/pmqueue/core/PersistentMessageQueue.html#QUEUE_HEADER_SIZE">QUEUE_HEADER_SIZE</a></code></div>
<div class="col-last even-row-color"><code>24</code></div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
33 changes: 33 additions & 0 deletions docs/copy.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/element-list
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
io.github.elimelt.pmqueue
io.github.elimelt.pmqueue.consumer
io.github.elimelt.pmqueue.core
io.github.elimelt.pmqueue.message
io.github.elimelt.pmqueue.producer
Loading

0 comments on commit ec1c772

Please sign in to comment.