PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-04-28 07:45:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/services/account/index.html

44 lines
32 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<!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.services.account</title><meta content="PSF - LoginServer - master - net.psforever.services.account" name="description"/><meta content="PSF LoginServer master net.psforever.services.account" 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 */
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
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.services" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="services"></a><a id="services:services"></a> <span class="permalink"><a href="../../../../net/psforever/services/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">services</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 current" name="net.psforever.services.account" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="account"></a><a id="account:account"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/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">account</span></span><div class="fu
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
a player connects, the LoginSessionActor handles the account login by querying the database,
comparing passwords etc, and then by inserting the account information into this actor by a
token that is also sent to the player's client in the LoginRespMessage packet. The token is
just like a browser cookie session token.</p><p>When the player's client has processed the LoginRespMessage packet, it attempts to connect
to the game world by sending a ConnectToWorldRequestMessage with the token which is used
by the WorldSessionActor to lookup the player's account info from this actor.</p><p>So this actor is a temporary store of account data for players logging into the login
server and crossing over to the world server.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
</p></div></div></li><li class="indented0 " name="net.psforever.services.account.AccountPersistenceService" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AccountPersistenceServiceextendsActor"></a><a id="AccountPersistenceService:AccountPersistenceService"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/AccountPersistenceService.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="AccountPersistenceService.html" title="A global service that manages user behavior as divided into the following three categories: persistence (ongoing participation in the game world), relogging (short-term client connectivity issue resolution), and logout (end-of-life conditions involving the separation of a user from the game world). A user polls this service and the service either creates a new PersistenceMonitor entity or returns whatever PersistenceMonitor entity currently exists."><span class="name">AccountPersistenceService</span></a><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span></span></span><p class="shortcomment cmt">A global service that manages user behavior as divided into the following three categories:
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
persistence (ongoing participation in the game world),
relogging (short-term client connectivity issue resolution), and
logout (end-of-life conditions involving the separation of a user from the game world).<br>
<br>
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
A user polls this service and the service either creates a new <code>PersistenceMonitor</code> entity
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
or returns whatever <code>PersistenceMonitor</code> entity currently exists.</p><div class="fullcomment"><div class="comment cmt"><p>A global service that manages user behavior as divided into the following three categories:
persistence (ongoing participation in the game world),
relogging (short-term client connectivity issue resolution), and
logout (end-of-life conditions involving the separation of a user from the game world).<br>
<br>
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
A user polls this service and the service either creates a new <code>PersistenceMonitor</code> entity
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
or returns whatever <code>PersistenceMonitor</code> entity currently exists.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
Performing informative updates to the monitor about the user's eventual player avatar instance
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
(which can be performed by messaging the service indirectly,
though sending directly to the monitor is recommended)
facilitate the management of persistence.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
If connectivity issues with the client are encountered by the user,
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
within a reasonable amount of time to connection restoration,
the user may regain control of their existing persistence monitor and, thus, the same player avatar.
End of life is mainly managed by the monitors internally
and the monitors only communicate up to this service when executing their "end-of-life" operations.
</p></div></div></li><li class="indented0 " name="net.psforever.services.account.IPAddress" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="IPAddressextendsAnyRef"></a><a id="IPAddress:IPAddress"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/IPAddress.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="IPAddress.html" title=""><span class="name">IPAddress</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></li><li class="indented0 " name="net.psforever.services.account.PersistenceMonitor" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PersistenceMonitorextendsActor"></a><a id="PersistenceMonitor:PersistenceMonitor"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/PersistenceMonitor.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="PersistenceMonitor.html" title="Observe and manage the persistence of a single named player avatar entity in the game world, with special care to the conditions of short interruption in connectivity (relogging) and end-of-life operations."><span class="name">PersistenceMonitor</span></a><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span></span></span><p class="shortcomment cmt">Observe and manage the persistence of a single named player avatar entity in the game world,
with special care to the conditions of short interruption in connectivity (relogging)
and end-of-life operations.</p><div class="fullcomment"><div class="comment cmt"><p>Observe and manage the persistence of a single named player avatar entity in the game world,
with special care to the conditions of short interruption in connectivity (relogging)
and end-of-life operations.
Upon login, the monitor will echo all of the current information about the user's (recent) login back to the <code>sender</code>.
With a zone and a coordinate position in that zone, a user's player avatar can be properly reconnected
or can be reconstructed.
Without actual recent activity,
the default information about the zone is an indication that the user must start this player avatar from scratch.
The monitor expects a reliable update messaging (heartbeat) to keep track of the important information
and to determine the conditions for end-of-life activity.</p></div></div></li><li class="indented0 " name="net.psforever.services.account.ReceiveAccountData" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ReceiveAccountDataextendsProductwithSerializable"></a><a id="ReceiveAccountData:ReceiveAccountData"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/ReceiveAccountData.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="ReceiveAccountData.html" title=""><span class="name">ReceiveAccountData</span></a><span class="params">(<span name="account">account: <a href="../../objects/Account.html" name="net.psforever.objects.Account" id="net.psforever.objects.Account" class="extype">Account</a></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.services.account.ReceiveIPAddress" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ReceiveIPAddressextendsProductwithSerializable"></a><a id="ReceiveIPAddress:ReceiveIPAddress"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/ReceiveIPAddress.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="ReceiveIPAddress.html" title=""><span class="name">ReceiveIPAddress</span></a><span class="params">(<span name="address">address: <a href="IPAddress.html" name="net.psforever.services.account.IPAddress" id="net.psforever.services.account.IPAddress" class="extype">IPAddress</a></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.services.account.RetrieveAccountData" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="RetrieveAccountDataextendsProductwithSerializable"></a><a id="RetrieveAccountData:RetrieveAccountData"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/RetrieveAccountData.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="RetrieveAccountData.html" title=""><span class="name">RetrieveAccountData</span></a><span class="params">(<span name="token">token: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.services.account.RetrieveIPAddress" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="RetrieveIPAddressextendsProductwithSerializable"></a><a id="RetrieveIPAddress:RetrieveIPAddress"></a> <span class="permalink"><a href="../../../../net/psforever/services/account/RetrieveIPAddress.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="RetrieveIPAddress.html" title=""><span class="name">RetrieveIPAddress</span></a><span class="params">(<span name="sessionID">sessionID: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.services.account.StoreAccountData" group="Ungro
Reference in a new issue Copy permalink