174 lines
14 KiB
HTML
174 lines
14 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (17) on Tue Sep 28 23:55:25 CEST 2021 -->
|
||
|
|
<title>All Classes and Interfaces (concord-server 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_server/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-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><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</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_server/nl/andrewl/concord_server/client/AuthenticationService.html" title="class in nl.andrewl.concord_server.client">AuthenticationService</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This authentication service provides support for managing the client's
|
||
|
|
authentication status, such as registering new clients, generating tokens,
|
||
|
|
and logging in.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/channel/Channel.html" title="class in nl.andrewl.concord_server.channel">Channel</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">Represents a single communication area in which messages are sent by clients
|
||
|
|
and received by all connected clients.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/cli/command/ChannelCommand.html" title="class in nl.andrewl.concord_server.cli.command">ChannelCommand</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">Command for interacting with channels on the server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/channel/ChannelManager.html" title="class in nl.andrewl.concord_server.channel">ChannelManager</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This manager is responsible for keeping track of all the channels in the
|
||
|
|
server, and controlling modifications to them.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/event/ChannelMoveHandler.html" title="class in nl.andrewl.concord_server.event">ChannelMoveHandler</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">Handles client requests to move to another channel.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/event/ChatHandler.html" title="class in nl.andrewl.concord_server.event">ChatHandler</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This handler is responsible for taking incoming chat messages and saving them
|
||
|
|
to the channel's message collection, and then relaying the new message to all
|
||
|
|
clients in the channel.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/event/ChatHistoryRequestHandler.html" title="class in nl.andrewl.concord_server.event">ChatHistoryRequestHandler</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">Handles client requests for sections of chat history for a particular channel.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="concord_server/nl/andrewl/concord_server/client/ClientConnectionData.html" title="class in nl.andrewl.concord_server.client">ClientConnectionData</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
|
||
|
|
<div class="block">Some common data that's used when dealing with a client who has just joined
|
||
|
|
the server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/client/ClientManager.html" title="class in nl.andrewl.concord_server.client">ClientManager</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">The client manager is responsible for managing the set of clients connected
|
||
|
|
to a server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/client/ClientThread.html" title="class in nl.andrewl.concord_server.client">ClientThread</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This thread is responsible for handling the connection to a single client of
|
||
|
|
a server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/util/CollectionUtils.html" title="class in nl.andrewl.concord_server.util">CollectionUtils</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/ConcordServer.html" title="class in nl.andrewl.concord_server">ConcordServer</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">The main server implementation, which handles accepting new clients.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/DiscoveryServerPublisher.html" title="class in nl.andrewl.concord_server">DiscoveryServerPublisher</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This component is responsible for publishing the server's metadata to any
|
||
|
|
discovery servers that have been defined in the server's configuration file.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/event/EventManager.html" title="class in nl.andrewl.concord_server.event">EventManager</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">The event manager is responsible for the server's ability to respond to
|
||
|
|
various client requests.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="concord_server/nl/andrewl/concord_server/util/IdProvider.html" title="interface in nl.andrewl.concord_server.util">IdProvider</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-tab5"><a href="concord_server/nl/andrewl/concord_server/client/InvalidIdentificationException.html" title="class in nl.andrewl.concord_server.client">InvalidIdentificationException</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
||
|
|
<div class="block">Exception that's thrown when a client's identification information is invalid.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/cli/command/ListClientsCommand.html" title="class in nl.andrewl.concord_server.cli.command">ListClientsCommand</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This command shows a list of all clients that are currently connected to the server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="concord_server/nl/andrewl/concord_server/event/MessageHandler.html" title="interface in nl.andrewl.concord_server.event">MessageHandler</a><<a href="concord_server/nl/andrewl/concord_server/event/MessageHandler.html" title="type parameter in MessageHandler">T</a> extends nl.andrewl.concord_core.msg.Message></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
||
|
|
<div class="block">Defines a component which can handle messages of a certain type which were
|
||
|
|
received from a client.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/cli/ServerCli.html" title="class in nl.andrewl.concord_server.cli">ServerCli</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">Simple command-line interface that's available when running the server.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="concord_server/nl/andrewl/concord_server/cli/ServerCliCommand.html" title="interface in nl.andrewl.concord_server.cli">ServerCliCommand</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-tab2"><a href="concord_server/nl/andrewl/concord_server/config/ServerConfig.html" title="class in nl.andrewl.concord_server.config">ServerConfig</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/config/ServerConfig.ChannelConfig.html" title="class in nl.andrewl.concord_server.config">ServerConfig.ChannelConfig</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/cli/command/StopCommand.html" title="class in nl.andrewl.concord_server.cli.command">StopCommand</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||
|
|
<div class="block">This command forcibly stops the server, disconnecting any clients.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/util/StringUtils.html" title="class in nl.andrewl.concord_server.util">StringUtils</a></div>
|
||
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
||
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="concord_server/nl/andrewl/concord_server/util/UUIDProvider.html" title="class in nl.andrewl.concord_server.util">UUIDProvider</a></div>
|
||
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </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>
|