AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
907eaa7014cde93e994514299f845079dafc5ad4
vilya/apidocs/com/threerings/parlor/client/ParlorDecoder.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

446 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_31) on Sat Mar 14 10:07:08 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ParlorDecoder (Vilya Core 1.6 API)</title>
<meta name="date" content="2015-03-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ParlorDecoder (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ParlorDecoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/parlor/client/InvitationResponseObserver.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/client/ParlorDirector.html" title="class in com.threerings.parlor.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/ParlorDecoder.html" target="_top">Frames</a></li>
<li><a href="ParlorDecoder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.threerings.parlor.client</div>
<h2 title="Class ParlorDecoder" class="title">Class ParlorDecoder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.presents.client.InvocationDecoder</li>
<li>
<ul class="inheritance">
<li>com.threerings.parlor.client.ParlorDecoder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ParlorDecoder</span>
extends com.threerings.presents.client.InvocationDecoder</pre>
<div class="block">Dispatches calls to a <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html" title="interface in com.threerings.parlor.client"><code>ParlorReceiver</code></a> instance.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#GAME_IS_READY">GAME_IS_READY</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#gameIsReady-int-"><code>ParlorReceiver.gameIsReady(int)</code></a>
notifications.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#RECEIVED_INVITE">RECEIVED_INVITE</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#receivedInvite-int-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-"><code>ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig)</code></a>
notifications.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#RECEIVED_INVITE_CANCELLATION">RECEIVED_INVITE_CANCELLATION</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#receivedInviteCancellation-int-"><code>ParlorReceiver.receivedInviteCancellation(int)</code></a>
notifications.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#RECEIVED_INVITE_RESPONSE">RECEIVED_INVITE_RESPONSE</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#receivedInviteResponse-int-int-java.lang.Object-"><code>ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object)</code></a>
notifications.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#RECEIVER_CODE">RECEIVER_CODE</a></span></code>
<div class="block">The generated hash code used to identify this receiver class.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.presents.client.InvocationDecoder">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.threerings.presents.client.InvocationDecoder</h3>
<code>receiver</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#ParlorDecoder-com.threerings.parlor.client.ParlorReceiver-">ParlorDecoder</a></span>(<a href="../../../../com/threerings/parlor/client/ParlorReceiver.html" title="interface in com.threerings.parlor.client">ParlorReceiver</a>&nbsp;receiver)</code>
<div class="block">Creates a decoder that may be registered to dispatch invocation
service notifications to the specified receiver.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#dispatchNotification-int-java.lang.Object:A-">dispatchNotification</a></span>(int&nbsp;methodId,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;args)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html#getReceiverCode--">getReceiverCode</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="RECEIVER_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RECEIVER_CODE</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RECEIVER_CODE</pre>
<div class="block">The generated hash code used to identify this receiver class.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.client.ParlorDecoder.RECEIVER_CODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="GAME_IS_READY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GAME_IS_READY</h4>
<pre>public static final&nbsp;int GAME_IS_READY</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#gameIsReady-int-"><code>ParlorReceiver.gameIsReady(int)</code></a>
notifications.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.client.ParlorDecoder.GAME_IS_READY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RECEIVED_INVITE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RECEIVED_INVITE</h4>
<pre>public static final&nbsp;int RECEIVED_INVITE</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#receivedInvite-int-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-"><code>ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig)</code></a>
notifications.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.client.ParlorDecoder.RECEIVED_INVITE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RECEIVED_INVITE_CANCELLATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RECEIVED_INVITE_CANCELLATION</h4>
<pre>public static final&nbsp;int RECEIVED_INVITE_CANCELLATION</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#receivedInviteCancellation-int-"><code>ParlorReceiver.receivedInviteCancellation(int)</code></a>
notifications.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.client.ParlorDecoder.RECEIVED_INVITE_CANCELLATION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RECEIVED_INVITE_RESPONSE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RECEIVED_INVITE_RESPONSE</h4>
<pre>public static final&nbsp;int RECEIVED_INVITE_RESPONSE</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html#receivedInviteResponse-int-int-java.lang.Object-"><code>ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object)</code></a>
notifications.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.client.ParlorDecoder.RECEIVED_INVITE_RESPONSE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ParlorDecoder-com.threerings.parlor.client.ParlorReceiver-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParlorDecoder</h4>
<pre>public&nbsp;ParlorDecoder(<a href="../../../../com/threerings/parlor/client/ParlorReceiver.html" title="interface in com.threerings.parlor.client">ParlorReceiver</a>&nbsp;receiver)</pre>
<div class="block">Creates a decoder that may be registered to dispatch invocation
service notifications to the specified receiver.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getReceiverCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceiverCode</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getReceiverCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getReceiverCode</code>&nbsp;in class&nbsp;<code>com.threerings.presents.client.InvocationDecoder</code></dd>
</dl>
</li>
</ul>
<a name="dispatchNotification-int-java.lang.Object:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dispatchNotification</h4>
<pre>public&nbsp;void&nbsp;dispatchNotification(int&nbsp;methodId,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;args)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>dispatchNotification</code>&nbsp;in class&nbsp;<code>com.threerings.presents.client.InvocationDecoder</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ParlorDecoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/parlor/client/InvitationResponseObserver.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/client/ParlorDirector.html" title="class in com.threerings.parlor.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/ParlorDecoder.html" target="_top">Frames</a></li>
<li><a href="ParlorDecoder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink