PSF-LoginServer/net/psforever/objects/guid/index.html

60 lines
47 KiB
HTML

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.guid</title><meta content="PSF - LoginServer - master - net.psforever.objects.guid" name="description"/><meta content="PSF LoginServer master net.psforever.objects.guid" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../lib/index.js"></script><script type="text/javascript" src="../../../../index.js"></script><script type="text/javascript" src="../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.ballistics" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ballistics"></a><a id="ballistics:ballistics"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../ballistics/index.html" title=""><span class="name">ballistics</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.ce" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ce"></a><a id="ce:ce"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ce/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../ce/index.html" title=""><span class="name">ce</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.definition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="definition"></a><a id="definition:definition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../definition/index.html" title=""><span class="name">definition</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.entity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="entity"></a><a id="entity:entity"></a> <span class="permalink"><a href="../../../../net/psforever/objects/entity/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../entity/index.html" title=""><span class="name">entity</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.equipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equipment"></a><a id="equipment:equipment"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../equipment/index.html" title=""><span class="name">equipment</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.geometry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="geometry"></a><a id="geometry:geometry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../geometry/index.html" title=""><span class="name">geometry</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 current" name="net.psforever.objects.guid" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="guid"></a><a id="guid:guid"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">guid</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.guid.key" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="key"></a><a id="key:key"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/key/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="key/index.html" title=""><span class="name">key</span></a></span></li><li class="indented5 " name="net.psforever.objects.guid.pool" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="pool"></a><a id="pool:pool"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/pool/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="pool/index.html" title=""><span class="name">pool</span></a></span></li><li class="indented5 " name="net.psforever.objects.guid.selector" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="selector"></a><a id="selector:selector"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/selector/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="selector/index.html" title=""><span class="name">selector</span></a></span></li><li class="indented5 " name="net.psforever.objects.guid.source" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="source"></a><a id="source:source"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/source/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="source/index.html" title=""><span class="name">source</span></a></span></li><li class="indented5 " name="net.psforever.objects.guid.uns" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="uns"></a><a id="uns:uns"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/uns/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="uns/index.html" title=""><span class="name">uns</span></a></span></li><li class="current-entities indented4"><span class="separator"></span> <a href="GUIDTask$.html" title="The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers. Almost all of these functions will be invoked from WorldSessionActor." class="object"></a><a href="GUIDTask$.html" title="The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers. Almost all of these functions will be invoked from WorldSessionActor.">GUIDTask</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="NumberPoolHub.html" title="A master object that manages NumberPools when they are applied to a single NumberSource." class="class"></a><a href="NumberPoolHub.html" title="A master object that manages NumberPools when they are applied to a single NumberSource.">NumberPoolHub</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="RegisteredToWrongPlaceException.html" title="The entity was registered, but not to the target UNS." class="class"></a><a href="RegisteredToWrongPlaceException.html" title="The entity was registered, but not to the target UNS.">RegisteredToWrongPlaceException</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="RegisteringException.html" title="" class="class"></a><a href="RegisteringException.html" title="">RegisteringException</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="StraightforwardTask.html" title="A primary unit of work in a workflow that is set up to execute and never be taken back." class="trait"></a><a href="StraightforwardTask.html" title="A primary unit of work in a workflow that is set up to execute and never be taken back.">StraightforwardTask</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="Task.html" title="A primary unit of work in a workflow." class="trait"></a><a href="Task.html" title="A primary unit of work in a workflow.">Task</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="TaskBehaviors.html" title="Parts of the task resolution lifecycle." class="trait"></a><a href="TaskBehaviors.html" title="Parts of the task resolution lifecycle.">TaskBehaviors</a></li><li class="current-entities indented4"><a href="TaskBundle$.html" title="" class="object"></a> <a href="TaskBundle.html" title="The packaging of a more complicated unit of work in a workflow in which one task relies on the successful completion of other tasks." class="class"></a><a href="TaskBundle.html" title="The packaging of a more complicated unit of work in a workflow in which one task relies on the successful completion of other tasks.">TaskBundle</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="TaskNotExecutedException.html" title="" class="class"></a><a href="TaskNotExecutedException.html" title="">TaskNotExecutedException</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="TaskWorkflow$.html" title="" class="object"></a><a href="TaskWorkflow$.html" title="">TaskWorkflow</a></li><li class="current-entities indented4"><a href="UniqueNumberOps$.html" title="" class="object"></a> <a href="UniqueNumberOps.html" title="Wrap around converted NumberPools and synchronize a portion of the number registration process as a part of the global unique identifier (GUID, UID) number system (UNS, &quot;unique number system&quot;)." class="class"></a><a href="UniqueNumberOps.html" title="Wrap around converted NumberPools and synchronize a portion of the number registration process as a part of the global unique identifier (GUID, UID) number system (UNS, &quot;unique number system&quot;).">UniqueNumberOps</a></li><li class="current-entities indented4"><a href="UniqueNumberSetup$.html" title="" class="object"></a> <a href="UniqueNumberSetup.html" title="A class for spawning Actors to manage the number pools and create a number system operations class to access those pools within the context of registering and unregistering." class="class"></a><a href="UniqueNumberSetup.html" title="A class for spawning Actors to manage the number pools and create a number system operations class to access those pools within the context of registering and unregistering.">UniqueNumberSetup</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="UnregisteringException.html" title="" class="class"></a><a href="UnregisteringException.html" title="">UnregisteringException</a></li><li class="indented4 " name="net.psforever.objects.inventory" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="inventory"></a><a id="inventory:inventory"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../inventory/index.html" title=""><span class="name">inventory</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.loadouts" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="loadouts"></a><a id="loadouts:loadouts"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../loadouts/index.html" title=""><span class="name">loadouts</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.locker" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="locker"></a><a id="locker:locker"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../locker/index.html" title=""><span class="name">locker</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject"></a><a id="serverobject:serverobject"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../serverobject/index.html" title=""><span class="name">serverobject</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.teamwork" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="teamwork"></a><a id="teamwork:teamwork"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../teamwork/index.html" title=""><span class="name">teamwork</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.vehicles" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="vehicles"></a><a id="vehicles:vehicles"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../vehicles/index.html" title=""><span class="name">vehicles</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.vital" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="vital"></a><a id="vital:vital"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../vital/index.html" title=""><span class="name">vital</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.zones" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="zones"></a><a id="zones:zones"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../zones/index.html" title=""><span class="name">zones</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li></ul></div></div><div id="content"><body class="package value"><div id="definition"><div class="big-circle package">p</div><p id="owner"><a href="../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></p><h1>guid<span class="permalink"><a href="../../../../net/psforever/objects/guid/index.html" title="Permalink"><i class="material-icons"></i></a></span></h1></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">guid</span></span></h4><div id="comment" class="fullcommenttop"></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="packages" class="package members"><h3>Package Members</h3><ol><li class="indented0 " name="net.psforever.objects.guid.key" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="key"></a><a id="key:key"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/key/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="key/index.html" title=""><span class="name">key</span></a></span></li><li class="indented0 " name="net.psforever.objects.guid.pool" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="pool"></a><a id="pool:pool"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/pool/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="pool/index.html" title=""><span class="name">pool</span></a></span></li><li class="indented0 " name="net.psforever.objects.guid.selector" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="selector"></a><a id="selector:selector"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/selector/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="selector/index.html" title=""><span class="name">selector</span></a></span></li><li class="indented0 " name="net.psforever.objects.guid.source" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="source"></a><a id="source:source"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/source/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="source/index.html" title=""><span class="name">source</span></a></span></li><li class="indented0 " name="net.psforever.objects.guid.uns" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="uns"></a><a id="uns:uns"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/uns/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="uns/index.html" title=""><span class="name">uns</span></a></span></li></ol></div><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NumberPoolHubextendsAnyRef"></a><a id="NumberPoolHub:NumberPoolHub"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="NumberPoolHub.html" title="A master object that manages NumberPools when they are applied to a single NumberSource."><span class="name">NumberPoolHub</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">A master object that manages <code>NumberPool</code>s when they are applied to a single <code>NumberSource</code>.</p><div class="fullcomment"><div class="comment cmt"><p>A master object that manages <code>NumberPool</code>s when they are applied to a single <code>NumberSource</code>.
It catalogs the numbers and ensures the pool contents are unique to each other.<br>
<br>
All globally unique numbers are sorted into user-defined groups called pools.
Pools are intended to pre-allocate certain numbers to certain tasks.
Two default pools also exist - "generic," for all numbers not formally placed into a pool, and a hidden restricted pool.
The former can accept a variety of numbers on the source not known at initialization time loaded into it.
The latter can only be set by the <code>NumberSource</code> and can not be affected once this object is created.</p></div></div></li><li class="indented0 " name="net.psforever.objects.guid.RegisteredToWrongPlaceException" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RegisteredToWrongPlaceExceptionextendsRuntimeException"></a><a id="RegisteredToWrongPlaceException:RegisteredToWrongPlaceException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/RegisteredToWrongPlaceException.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="RegisteredToWrongPlaceException.html" title="The entity was registered, but not to the target UNS."><span class="name">RegisteredToWrongPlaceException</span></a><span class="result"> extends <span name="scala.RuntimeException" class="extype">RuntimeException</span></span></span><p class="shortcomment cmt">The entity was registered, but not to the target UNS.</p><div class="fullcomment"><div class="comment cmt"><p>The entity was registered, but not to the target UNS.
Rookie mistake.</p></div></div></li><li class="indented0 " name="net.psforever.objects.guid.RegisteringException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="RegisteringExceptionextendsException"></a><a id="RegisteringException:RegisteringException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/RegisteringException.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="RegisteringException.html" title=""><span class="name">RegisteringException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span></li><li class="indented0 " name="net.psforever.objects.guid.StraightforwardTask" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="StraightforwardTaskextendsTask"></a><a id="StraightforwardTask:StraightforwardTask"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/StraightforwardTask.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="StraightforwardTask.html" title="A primary unit of work in a workflow that is set up to execute and never be taken back."><span class="name">StraightforwardTask</span></a><span class="result"> extends <a href="Task.html" name="net.psforever.objects.guid.Task" id="net.psforever.objects.guid.Task" class="extype">Task</a></span></span><p class="shortcomment cmt">A primary unit of work in a workflow that is set up to execute and never be taken back.</p><div class="fullcomment"><div class="comment cmt"><p>A primary unit of work in a workflow that is set up to execute and never be taken back.
Good for top-level tasking that only reports on the success of work carried out by subtasks.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.guid.Task" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="TaskextendsTaskBehaviors"></a><a id="Task:Task"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/Task.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="Task.html" title="A primary unit of work in a workflow."><span class="name">Task</span></a><span class="result"> extends <a href="TaskBehaviors.html" name="net.psforever.objects.guid.TaskBehaviors" id="net.psforever.objects.guid.TaskBehaviors" class="extype">TaskBehaviors</a></span></span><p class="shortcomment cmt">A primary unit of work in a workflow.</p></li><li class="indented0 " name="net.psforever.objects.guid.TaskBehaviors" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="TaskBehaviorsextendsAnyRef"></a><a id="TaskBehaviors:TaskBehaviors"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/TaskBehaviors.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="TaskBehaviors.html" title="Parts of the task resolution lifecycle."><span class="name">TaskBehaviors</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Parts of the task resolution lifecycle.</p></li><li class="indented0 " name="net.psforever.objects.guid.TaskBundle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TaskBundleextendsTaskBehaviorswithProductwithSerializable"></a><a id="TaskBundle:TaskBundle"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/TaskBundle.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="TaskBundle.html" title="The packaging of a more complicated unit of work in a workflow in which one task relies on the successful completion of other tasks."><span class="name">TaskBundle</span></a><span class="params">(<span name="mainTask">mainTask: <a href="Task.html" name="net.psforever.objects.guid.Task" id="net.psforever.objects.guid.Task" class="extype">Task</a></span>, <span name="subTasks">subTasks: <span name="scala.Seq" class="extype">Seq</span>[<a href="TaskBundle.html" name="net.psforever.objects.guid.TaskBundle" id="net.psforever.objects.guid.TaskBundle" class="extype">TaskBundle</a>]</span>)</span><span class="result"> extends <a href="TaskBehaviors.html" name="net.psforever.objects.guid.TaskBehaviors" id="net.psforever.objects.guid.TaskBehaviors" class="extype">TaskBehaviors</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">The packaging of a more complicated unit of work in a workflow
in which one task relies on the successful completion of other tasks.</p><div class="fullcomment"><div class="comment cmt"><p>The packaging of a more complicated unit of work in a workflow
in which one task relies on the successful completion of other tasks.</p></div><dl class="paramcmts block"><dt class="param">mainTask</dt><dd class="cmt"><p>the primary task</p></dd><dt class="param">subTasks</dt><dd class="cmt"><p>tasks that are necessary to complete before starting on the primary one</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.TaskNotExecutedException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="TaskNotExecutedExceptionextendsException"></a><a id="TaskNotExecutedException:TaskNotExecutedException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/TaskNotExecutedException.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="TaskNotExecutedException.html" title=""><span class="name">TaskNotExecutedException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span></li><li class="indented0 " name="net.psforever.objects.guid.UniqueNumberOps" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UniqueNumberOpsextendsAnyRef"></a><a id="UniqueNumberOps:UniqueNumberOps"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="UniqueNumberOps.html" title="Wrap around converted NumberPools and synchronize a portion of the number registration process as a part of the global unique identifier (GUID, UID) number system (UNS, &quot;unique number system&quot;)."><span class="name">UniqueNumberOps</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Wrap around converted <code>NumberPool</code>s and synchronize a portion of the number registration process
as a part of the global unique identifier (GUID, UID) number system (UNS, "unique number system").</p><div class="fullcomment"><div class="comment cmt"><p>Wrap around converted <code>NumberPool</code>s and synchronize a portion of the number registration process
as a part of the global unique identifier (GUID, UID) number system (UNS, "unique number system").
The ultimate goal is to manage a coherent group of unique identifiers for a given "region".
Both parts of the UID system sit atop the <code>Zone</code> for easy external access.
The plain part - the <code>NumberPoolHub</code> here - is used for low-priority requests
such as checking for existing associations.<br>
<br>
A four part process is used for object registration tasks.
First, the requested <code>NumberPool</code> is located among the list of known <code>NumberPool</code>s.
Second, an asynchronous request is sent to that pool to retrieve a number.
(Only any number. Only a failing case allows for selection of a specific number.)
Third, the asynchronous request returns and the original information about the request is recovered.
Fourth, both sides of the contract are completed by the object being assigned the number and
the underlying "number source" is made to remember an association between the object and the number.
Short circuits and recoveries as available on all steps though reporting is split between logging and callbacks.
The process of removing the association between a number and object (unregistering) is a similar four part process.<br>
<br>
The important relationship between this <code>Actor</code> and the <code>Map</code> of <code>NumberPoolActors</code> is as a "gate."
A single <code>Map</code> is constructed and shared between multiple entry points to the UID system where requests are messaged.
Multiple entry points send messages to the same <code>NumberPool</code>.
That <code>NumberPool</code> deals with the messages one at a time and sends reply to each entry point that communicated with it.
This process is almost as fast as the process of the <code>NumberPool</code> selecting a number.
(At least, both should be fast.)</p></div></div></li><li class="indented0 " name="net.psforever.objects.guid.UniqueNumberSetup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UniqueNumberSetupextendsActor"></a><a id="UniqueNumberSetup:UniqueNumberSetup"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberSetup.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="UniqueNumberSetup.html" title="A class for spawning Actors to manage the number pools and create a number system operations class to access those pools within the context of registering and unregistering."><span class="name">UniqueNumberSetup</span></a><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span></span></span><p class="shortcomment cmt">A class for spawning <code>Actor</code>s to manage the number pools and
create a number system operations class to access those pools within the context of registering and unregistering.</p><div class="fullcomment"><div class="comment cmt"><p>A class for spawning <code>Actor</code>s to manage the number pools and
create a number system operations class to access those pools within the context of registering and unregistering.
This <code>Actor</code> persists to maintain the number pool <code>Actor</code>s.
Note the <code>final</code> do-nothing <code>receive</code> method.
This <code>Actor</code> should do <u>nothing</u> through message passing.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>UniqueNumberOps</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.UnregisteringException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UnregisteringExceptionextendsException"></a><a id="UnregisteringException:UnregisteringException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UnregisteringException.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="UnregisteringException.html" title=""><span class="name">UnregisteringException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.guid.GUIDTask" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GUIDTask"></a><a id="GUIDTask:GUIDTask"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/GUIDTask$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="GUIDTask$.html" title="The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers. Almost all of these functions will be invoked from WorldSessionActor."><span class="name">GUIDTask</span></a></span><p class="shortcomment cmt">The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers.<br>
<br>
Almost all of these functions will be invoked from <code>WorldSessionActor</code>.</p><div class="fullcomment"><div class="comment cmt"><p>The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers.<br>
<br>
Almost all of these functions will be invoked from <code>WorldSessionActor</code>.
Some of the "unregistering" functions will invoke on delayed <code>Service</code> operations,
indicating behavior that is not user/observer dependent.
The object's (current) <code>Zone</code> must also be knowable since the GUID systems are tied to individual zones.
For simplicity, all functions have the same format where the hook into the GUID system is an <code>implicit</code> parameter.
It will get passed from the more complicated functions down into the less complicated functions,
until it has found the basic number assignment functionality.<br>
<br>
All functions produce a <code>TaskBundle</code> container object
or a list of <code>TaskBundle</code> container objects that is expected to be used by a <code>TaskBundle</code> container.
These "task containers" can also be unpackaged into their component tasks, sorted into other containers,
and combined with other tasks to enact more complicated sequences of operations.
Almost all tasks have an explicit registering and an unregistering activity defined for it.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.guid.TaskBundle" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="TaskBundle"></a><a id="TaskBundle:TaskBundle"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/TaskBundle$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="TaskBundle$.html" title=""><span class="name">TaskBundle</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.guid.TaskWorkflow" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="TaskWorkflow"></a><a id="TaskWorkflow:TaskWorkflow"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/TaskWorkflow$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="TaskWorkflow$.html" title=""><span class="name">TaskWorkflow</span></a></span></li><li class="indented0 " name="net.psforever.objects.guid.UniqueNumberOps" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UniqueNumberOps"></a><a id="UniqueNumberOps:UniqueNumberOps"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="UniqueNumberOps$.html" title=""><span class="name">UniqueNumberOps</span></a></span></li><li class="indented0 " name="net.psforever.objects.guid.UniqueNumberSetup" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UniqueNumberSetup"></a><a id="UniqueNumberSetup:UniqueNumberSetup"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberSetup$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="UniqueNumberSetup$.html" title=""><span class="name">UniqueNumberSetup</span></a></span></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>