PSF-LoginServer/net/psforever/packet/control/index.html

16 lines
48 KiB
HTML
Raw Permalink Normal View History

<!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.packet.control</title><meta content="PSF - LoginServer - master - net.psforever.packet.control" name="description"/><meta content="PSF LoginServer master net.psforever.packet.control" 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_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></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" class="anchorToMember"></a><a id="net:net" class="anchorToMember"></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" class="anchorToMember"></a><a id="psforever:psforever" class="anchorToMember"></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.packet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="packet" class="anchorToMember"></a><a id="packet:packet" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/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">packet</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.packet.control" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="control" class="anchorToMember"></a><a id="control:control" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/index.html" title="Permalink"><i cla
increments by 41 per packet</p></dd><dt class="param">field64B</dt><dd class="cmt"><p>na;
increments by 21 per packet</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.control.ControlSyncResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ControlSyncRespextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="ControlSyncResp:ControlSyncResp" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/ControlSyncResp.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="ControlSyncResp.html" title="The response packet dispatched by the server to a client's ControlSync packet."><span class="name">ControlSyncResp</span></a><span class="params">(<span name="timeDiff">timeDiff: <span name="scala.Int" class="extype">Int</span></span>, <span name="serverTick">serverTick: <span name="scala.Long" class="extype">Long</span></span>, <span name="field1">field1: <span name="scala.Long" class="extype">Long</span></span>, <span name="field2">field2: <span name="scala.Long" class="extype">Long</span></span>, <span name="field3">field3: <span name="scala.Long" class="extype">Long</span></span>, <span name="field4">field4: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</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 response packet dispatched by the server to a client's <code>ControlSync</code> packet.</p><div class="fullcomment"><div class="comment cmt"><p>The response packet dispatched by the server to a client's <code>ControlSync</code> packet.
As noted, it echoes most of the fields originating from within its companion packet except for <code>serverTick</code>.</p></div><dl class="paramcmts block"><dt class="param">timeDiff</dt><dd class="cmt"><p>na;
echoes <code>ControlSync.timeDiff</code></p></dd><dt class="param">serverTick</dt><dd class="cmt"><p>na</p></dd><dt class="param">field1</dt><dd class="cmt"><p>na;
echoes <code>ControlSync.field64A</code></p></dd><dt class="param">field2</dt><dd class="cmt"><p>na;
echoes <code>ControlSync.field64B</code></p></dd><dt class="param">field3</dt><dd class="cmt"><p>na;
echoes <code>ControlSync.field64B</code> (+/- 1)</p></dd><dt class="param">field4</dt><dd class="cmt"><p>na;
echoes <code>ControlSync.field64A</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.control.HandleGamePacket" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="HandleGamePacketextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="HandleGamePacket:HandleGamePacket" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/HandleGamePacket.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="HandleGamePacket.html" title=""><span class="name">HandleGamePacket</span></a><span class="params">(<span name="len">len: <span name="scala.Int" class="extype">Int</span></span>, <span name="stream">stream: <span name="scodec.bits.ByteVector" class="extype">ByteVector</span></span>, <span name="rest">rest: <span name="scodec.bits.BitVector" class="extype">BitVector</span> = <span class="symbol"><span class="name"><a href="../../../../scodec/index.html">BitVector.empty</a></span></span></span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</a> with <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.packet.control.MultiPacket" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="MultiPacketextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="MultiPacket:MultiPacket" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/MultiPacket.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="MultiPacket.html" title=""><span class="name">MultiPacket</span></a><span class="params">(<span name="packets">packets: <span name="scala.Vector" class="extype">Vector</span>[<span name="scodec.bits.ByteVector" class="extype">ByteVector</span>]</span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</a> with <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.packet.control.MultiPacketEx" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="MultiPacketExextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="MultiPacketEx:MultiPacketEx" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/MultiPacketEx.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="MultiPacketEx.html" title=""><span class="name">MultiPacketEx</span></a><span class="params">(<span name="packets">packets: <span name="scala.Vector" class="extype">Vector</span>[<span name="scodec.bits.ByteVector" class="extype">ByteVector</span>]</span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</a> with <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.packet.control.Rela
Explains which packet was in error by sending back its <code>subslot</code> number.</p></div><dl class="paramcmts block"><dt class="param">slot</dt><dd class="cmt"><p>the type of <code>ResultA</code> packet;
valid types are integers 0-3</p></dd><dt class="param">subslot</dt><dd class="cmt"><p>identification of a control packet</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.control.RelatedB" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RelatedBextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="RelatedB:RelatedB" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/RelatedB.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="RelatedB.html" title="Dispatched to coordinate information regarding ControlPacket packets between the client and server."><span class="name">RelatedB</span></a><span class="params">(<span name="slot">slot: <span name="scala.Int" class="extype">Int</span></span>, <span name="subslot">subslot: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</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">Dispatched to coordinate information regarding <code>ControlPacket</code> packets between the client and server.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatched to coordinate information regarding <code>ControlPacket</code> packets between the client and server.
When dispatched by the client, it relates the current (or last received) <code>SlottedMetaPacket</code> <code>subslot</code> number back to the server.
When dispatched by the server, it relates ???</p></div><dl class="paramcmts block"><dt class="param">slot</dt><dd class="cmt"><p>the type of <code>ResultB</code> packet;
valid types are integers 0-3</p></dd><dt class="param">subslot</dt><dd class="cmt"><p>identification of a control packet</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.control.ServerStart" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ServerStartextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="ServerStart:ServerStart" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/ServerStart.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="ServerStart.html" title=""><span class="name">ServerStart</span></a><span class="params">(<span name="clientNonce">clientNonce: <span name="scala.Long" class="extype">Long</span></span>, <span name="serverNonce">serverNonce: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</a> with <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.packet.control.SlottedMetaPacket" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SlottedMetaPacketextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="SlottedMetaPacket:SlottedMetaPacket" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/SlottedMetaPacket.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="SlottedMetaPacket.html" title=""><span class="name">SlottedMetaPacket</span></a><span class="params">(<span name="slot">slot: <span name="scala.Int" class="extype">Int</span></span>, <span name="subslot">subslot: <span name="scala.Int" class="extype">Int</span></span>, <span name="packet">packet: <span name="scodec.bits.ByteVector" class="extype">ByteVector</span></span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</a> with <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.packet.control.TeardownConnection" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="TeardownConnectionextendsPlanetSideControlPacketwithProductwithSerializable" class="anchorToMember"></a><a id="TeardownConnection:TeardownConnection" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/control/TeardownConnection.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="TeardownConnection.html" title=""><span class="name">TeardownConnection</span></a><span class="params">(<span name="targetNonce">targetNonce: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result"> extends <a href="../PlanetSideControlPacket.html" name="net.psforever.packet.PlanetSideControlPacket" id="net.psforever.packet.PlanetSideControlPacket" class="extype">PlanetSideControlPacket</a> with <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.packet.control.Unknown30" group="Ungrouped" fullComment="no"