mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-03-09 07:20:30 +00:00
30 lines
44 KiB
HTML
30 lines
44 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.UniqueNumberOps</title><meta content="PSF - LoginServer - master - net.psforever.objects.guid.UniqueNumberOps" name="description"/><meta content="PSF LoginServer master net.psforever.objects.guid.UniqueNumberOps" 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"><</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.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"><a href="index.html" title=""><span class="name">guid</span></a></span><div class="f
|
||
|
|
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><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/objects/guid/UniqueNumberOps.scala" target="_blank">UniqueNumberOps.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></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><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.objects.guid.UniqueNumberOps"><span>UniqueNumberOps</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</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="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.objects.guid.UniqueNumberOps#<init>" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="<init>(guid:net.psforever.objects.guid.NumberPoolHub,poolActors:Map[String,akka.actor.ActorRef]):net.psforever.objects.guid.UniqueNumberOps"></a><a id="<init>:UniqueNumberOps"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#<init>(guid:net.psforever.objects.guid.NumberPoolHub,poolActors:Map[String,akka.actor.ActorRef]):net.psforever.objects.guid.UniqueNumberOps" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">UniqueNumberOps</span><span class="params">(<span name="guid">guid: <a href="NumberPoolHub.html" name="net.psforever.objects.guid.NumberPoolHub" id="net.psforever.objects.guid.NumberPoolHub" class="extype">NumberPoolHub</a></span>, <span name="poolActors">poolActors: <span name="scala.Predef.Map" class="extype">Map</span>[<span name="scala.Predef.String" class="extype">String</span>, <span name="akka.actor.ActorRef" class="extype">ActorRef</span>]</span>)</span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the supporting datatype for the unique number distribution</p></dd><dt class="param">poolActors</dt><dd class="cmt"><p>a mapping created from the <code>NumberPool</code>s, to achieve synchronized access</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">ar
|
||
|
|
A special check is made first to determine if the entity is already registered, and if so to where.
|
||
|
|
If the entity is not registered, then the process continues.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the entity to be assigned a GUID</p></dd><dt class="param">poolName</dt><dd class="cmt"><p>the pool from which the entity wants a GUID to be selected</p></dd><dt>returns</dt><dd class="cmt"><p>the anticipation of this activity being completed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.UniqueNumberOps#Unregister" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Unregister(obj:net.psforever.objects.entity.IdentifiableEntity):scala.concurrent.Future[Any]"></a><a id="Unregister(IdentifiableEntity):Future[Any]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#Unregister(obj:net.psforever.objects.entity.IdentifiableEntity):scala.concurrent.Future[Any]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Unregister</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>)</span><span class="result">: <span name="scala.concurrent.Future" class="extype">Future</span>[<span name="scala.Any" class="extype">Any</span>]</span></span><p class="shortcomment cmt">The entry point for the entity GUID unregistration process.</p><div class="fullcomment"><div class="comment cmt"><p>The entry point for the entity GUID unregistration process.
|
||
|
|
A special check is made first to determine where, if at all, the entity is registered.
|
||
|
|
Obviously, if the entity is not registered somewhere within purview of this UNS, the process can not continue.
|
||
|
|
If the entity's registration number pool is found, then the process continues.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the entity to be unassigned its GUID</p></dd><dt>returns</dt><dd class="cmt"><p>the anticipation of this activity being completed</p></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#equals(x$1:Object):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/UniqueNumberOps.html#finalize():Unit" title="Permalink"><i class="ma
|