203 lines
18 KiB
HTML
203 lines
18 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (17) on Tue Sep 28 23:55:20 CEST 2021 -->
|
||
|
|
<title>All Classes and Interfaces (concord-core 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="2021-09-28">
|
||
|
|
<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">
|
||
|
|
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
||
|
|
<script type="text/javascript" src="script.js"></script>
|
||
|
|
<script type="text/javascript" src="script-dir/jquery-3.5.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 evenRowColor = "even-row-color";
|
||
|
|
var oddRowColor = "odd-row-color";
|
||
|
|
var tableTab = "table-tab";
|
||
|
|
var activeTableTab = "active-table-tab";
|
||
|
|
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">
|
||
|
|
<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="concord_core/module-summary.html">Module</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 class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
||
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||
|
|
</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">Enum Classes</button><button id="all-classes-table-tab4" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab4', 2)" class="table-tab">Record Classes</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="concord_core/nl/andrewl/concord_core/util/ChainedDataOutputStream.html" title="class in nl.andrewl.concord_core.util">ChainedDataOutputStream</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">A more complex output stream which redefines certain methods for convenience
|
||
|
|
with method chaining.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/chat/Chat.html" title="class in nl.andrewl.concord_core.msg.types.chat">Chat</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">This message contains information about a chat message that a user sent.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/chat/ChatHistoryRequest.html" title="class in nl.andrewl.concord_core.msg.types.chat">ChatHistoryRequest</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">A message which clients can send to the server to request some messages from
|
||
|
|
the server's history of all sent messages from a particular source.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/chat/ChatHistoryResponse.html" title="class in nl.andrewl.concord_core.msg.types.chat">ChatHistoryResponse</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">The response that a server sends to a <a href="concord_core/nl/andrewl/concord_core/msg/types/chat/ChatHistoryRequest.html" title="class in nl.andrewl.concord_core.msg.types.chat"><code>ChatHistoryRequest</code></a>.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/client_setup/ClientLogin.html" title="class in nl.andrewl.concord_core.msg.types.client_setup">ClientLogin</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">This message is sent by clients to log into a server that they have already
|
||
|
|
registered with, but don't have a valid session token for.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/client_setup/ClientRegistration.html" title="class in nl.andrewl.concord_core.msg.types.client_setup">ClientRegistration</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">The data that new users should send to a server in order to register in that
|
||
|
|
server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/client_setup/ClientSessionResume.html" title="class in nl.andrewl.concord_core.msg.types.client_setup">ClientSessionResume</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">This message is sent by the client to log into a server using a session token
|
||
|
|
instead of a username/password combination.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/channel/CreateThread.html" title="class in nl.andrewl.concord_core.msg.types.channel">CreateThread</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">This message is sent by clients when they indicate that they would like to
|
||
|
|
create a new thread in their current channel.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_core/nl/andrewl/concord_core/msg/Encryption.html" title="class in nl.andrewl.concord_core.msg">Encryption</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">Utility class for handling the establishment of encrypted communication.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/Error.html" title="class in nl.andrewl.concord_core.msg.types">Error</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Error message which can be sent between either the server or client to
|
||
|
|
indicate an unsavory situation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="concord_core/nl/andrewl/concord_core/msg/types/Error.Level.html" title="enum class in nl.andrewl.concord_core.msg.types">Error.Level</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
|
||
|
|
<div class="block">The error level gives an indication as to the severity of the error.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_core/nl/andrewl/concord_core/util/ExtendedDataInputStream.html" title="class in nl.andrewl.concord_core.util">ExtendedDataInputStream</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">An extended output stream which contains additional methods for reading more
|
||
|
|
complex types that are used by the Concord system.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/client_setup/KeyData.html" title="class in nl.andrewl.concord_core.msg.types.client_setup">KeyData</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">This message is sent as the first message from both the server and the client
|
||
|
|
to establish an end-to-end encryption via a key exchange.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="concord_core/nl/andrewl/concord_core/msg/Message.html" title="interface in nl.andrewl.concord_core.msg">Message</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||
|
|
<div class="block">Represents any message which can be sent over the network.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="concord_core/nl/andrewl/concord_core/msg/MessageReader.html" title="interface in nl.andrewl.concord_core.msg">MessageReader</a><<a href="concord_core/nl/andrewl/concord_core/msg/MessageReader.html" title="type parameter in MessageReader">T</a> extends <a href="concord_core/nl/andrewl/concord_core/msg/Message.html" title="interface in nl.andrewl.concord_core.msg">Message</a>></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> </div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/MessageTypeSerializer.html" title="class in nl.andrewl.concord_core.msg">MessageTypeSerializer</a><<a href="concord_core/nl/andrewl/concord_core/msg/MessageTypeSerializer.html" title="type parameter in MessageTypeSerializer">T</a> extends <a href="concord_core/nl/andrewl/concord_core/msg/Message.html" title="interface in nl.andrewl.concord_core.msg">Message</a>></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Record containing the components needed to read and write a given message.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_core/nl/andrewl/concord_core/msg/MessageUtils.html" title="class in nl.andrewl.concord_core.msg">MessageUtils</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">Utility class which provides method for serializing and deserializing complex
|
||
|
|
data types.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="concord_core/nl/andrewl/concord_core/msg/MessageWriter.html" title="interface in nl.andrewl.concord_core.msg">MessageWriter</a><<a href="concord_core/nl/andrewl/concord_core/msg/MessageWriter.html" title="type parameter in MessageWriter">T</a> extends <a href="concord_core/nl/andrewl/concord_core/msg/Message.html" title="interface in nl.andrewl.concord_core.msg">Message</a>></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/channel/MoveToChannel.html" title="class in nl.andrewl.concord_core.msg.types.channel">MoveToChannel</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">A message that's sent to a client when they've been moved to another channel.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/util/Pair.html" title="class in nl.andrewl.concord_core.util">Pair</a><<a href="concord_core/nl/andrewl/concord_core/util/Pair.html" title="type parameter in Pair">A</a>,<wbr><a href="concord_core/nl/andrewl/concord_core/util/Pair.html" title="type parameter in Pair">B</a>></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Simple generic pair of two objects.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/client_setup/RegistrationStatus.html" title="class in nl.andrewl.concord_core.msg.types.client_setup">RegistrationStatus</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">A response from the server which indicates the current status of the client's
|
||
|
|
registration request.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="concord_core/nl/andrewl/concord_core/msg/types/client_setup/RegistrationStatus.Type.html" title="enum class in nl.andrewl.concord_core.msg.types.client_setup">RegistrationStatus.Type</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> </div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_core/nl/andrewl/concord_core/msg/Serializer.html" title="class in nl.andrewl.concord_core.msg">Serializer</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This class is responsible for reading and writing messages from streams.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/ServerMetaData.html" title="class in nl.andrewl.concord_core.msg.types">ServerMetaData</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Metadata is sent by the server to clients to inform them of the structure of
|
||
|
|
the server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/ServerMetaData.ChannelData.html" title="class in nl.andrewl.concord_core.msg.types">ServerMetaData.ChannelData</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Metadata about a top-level channel in the server which is visible and
|
||
|
|
joinable for a user.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/ServerUsers.html" title="class in nl.andrewl.concord_core.msg.types">ServerUsers</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">This message is sent from the server to the client whenever a change happens
|
||
|
|
which requires the server to notify clients about a change of the list of
|
||
|
|
global users.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/client_setup/ServerWelcome.html" title="class in nl.andrewl.concord_core.msg.types.client_setup">ServerWelcome</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">This message is sent from the server to the client after the server accepts
|
||
|
|
the client's identification and registers the client in the server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/util/Triple.html" title="class in nl.andrewl.concord_core.util">Triple</a><<a href="concord_core/nl/andrewl/concord_core/util/Triple.html" title="type parameter in Triple">A</a>,<wbr><a href="concord_core/nl/andrewl/concord_core/util/Triple.html" title="type parameter in Triple">B</a>,<wbr><a href="concord_core/nl/andrewl/concord_core/util/Triple.html" title="type parameter in Triple">C</a>></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Simple generic triple of objects.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="concord_core/nl/andrewl/concord_core/msg/types/UserData.html" title="class in nl.andrewl.concord_core.msg.types">UserData</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Standard set of user data that is used mainly as a component of other more
|
||
|
|
complex messages.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</main>
|
||
|
|
<footer role="contentinfo">
|
||
|
|
<hr>
|
||
|
|
<p class="legal-copy"><small>Copyright © 2021. All rights reserved.</small></p>
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|