Files
vilya/apidocs/com/threerings/parlor/data/TableLobbyObject.html
T
2015-03-14 10:44:30 -07:00

325 lines
14 KiB
HTML

<!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>TableLobbyObject (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="TableLobbyObject (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/TableLobbyObject.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/data/TableConfig.html" title="class in com.threerings.parlor.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/data/TableMarshaller.html" title="class in com.threerings.parlor.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/data/TableLobbyObject.html" target="_top">Frames</a></li>
<li><a href="TableLobbyObject.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.data</div>
<h2 title="Interface TableLobbyObject" class="title">Interface TableLobbyObject</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../com/threerings/micasa/lobby/table/TableLobbyObject.html" title="class in com.threerings.micasa.lobby.table">TableLobbyObject</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TableLobbyObject</span></pre>
<div class="block">This interface must be implemented by the place object used by a lobby
that wishes to make use of the table services.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/data/TableLobbyObject.html#addToTables-com.threerings.parlor.data.Table-">addToTables</a></span>(<a href="../../../../com/threerings/parlor/data/Table.html" title="class in com.threerings.parlor.data">Table</a>&nbsp;table)</code>
<div class="block">Adds the supplied table instance to the tables set (using the
appropriate distributed object mechanisms).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>com.threerings.presents.dobj.DSet&lt;<a href="../../../../com/threerings/parlor/data/Table.html" title="class in com.threerings.parlor.data">Table</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/TableLobbyObject.html#getTables--">getTables</a></span>()</code>
<div class="block">Returns a reference to the distributed set instance that will be
holding the tables.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../com/threerings/parlor/data/TableMarshaller.html" title="class in com.threerings.parlor.data">TableMarshaller</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/TableLobbyObject.html#getTableService--">getTableService</a></span>()</code>
<div class="block">Returns a reference to the table service configured in this object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/TableLobbyObject.html#removeFromTables-java.lang.Comparable-">removeFromTables</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&nbsp;key)</code>
<div class="block">Removes the table instance that matches the specified key from the
tables set (using the appropriate distributed object mechanisms).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/TableLobbyObject.html#setTableService-com.threerings.parlor.data.TableMarshaller-">setTableService</a></span>(<a href="../../../../com/threerings/parlor/data/TableMarshaller.html" title="class in com.threerings.parlor.data">TableMarshaller</a>&nbsp;service)</code>
<div class="block">Configures the table service that clients should use to communicate table requests back to
the table manager handling these tables.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/TableLobbyObject.html#updateTables-com.threerings.parlor.data.Table-">updateTables</a></span>(<a href="../../../../com/threerings/parlor/data/Table.html" title="class in com.threerings.parlor.data">Table</a>&nbsp;table)</code>
<div class="block">Updates the value of the specified table instance in the tables
distributed set (using the appropriate distributed object
mechanisms).</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTables--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTables</h4>
<pre>com.threerings.presents.dobj.DSet&lt;<a href="../../../../com/threerings/parlor/data/Table.html" title="class in com.threerings.parlor.data">Table</a>&gt;&nbsp;getTables()</pre>
<div class="block">Returns a reference to the distributed set instance that will be
holding the tables.</div>
</li>
</ul>
<a name="addToTables-com.threerings.parlor.data.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToTables</h4>
<pre>void&nbsp;addToTables(<a href="../../../../com/threerings/parlor/data/Table.html" title="class in com.threerings.parlor.data">Table</a>&nbsp;table)</pre>
<div class="block">Adds the supplied table instance to the tables set (using the
appropriate distributed object mechanisms).</div>
</li>
</ul>
<a name="updateTables-com.threerings.parlor.data.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateTables</h4>
<pre>void&nbsp;updateTables(<a href="../../../../com/threerings/parlor/data/Table.html" title="class in com.threerings.parlor.data">Table</a>&nbsp;table)</pre>
<div class="block">Updates the value of the specified table instance in the tables
distributed set (using the appropriate distributed object
mechanisms).</div>
</li>
</ul>
<a name="removeFromTables-java.lang.Comparable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFromTables</h4>
<pre>void&nbsp;removeFromTables(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&nbsp;key)</pre>
<div class="block">Removes the table instance that matches the specified key from the
tables set (using the appropriate distributed object mechanisms).</div>
</li>
</ul>
<a name="getTableService--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableService</h4>
<pre><a href="../../../../com/threerings/parlor/data/TableMarshaller.html" title="class in com.threerings.parlor.data">TableMarshaller</a>&nbsp;getTableService()</pre>
<div class="block">Returns a reference to the table service configured in this object.</div>
</li>
</ul>
<a name="setTableService-com.threerings.parlor.data.TableMarshaller-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setTableService</h4>
<pre>void&nbsp;setTableService(<a href="../../../../com/threerings/parlor/data/TableMarshaller.html" title="class in com.threerings.parlor.data">TableMarshaller</a>&nbsp;service)</pre>
<div class="block">Configures the table service that clients should use to communicate table requests back to
the table manager handling these tables.</div>
</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/TableLobbyObject.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/data/TableConfig.html" title="class in com.threerings.parlor.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/data/TableMarshaller.html" title="class in com.threerings.parlor.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/data/TableLobbyObject.html" target="_top">Frames</a></li>
<li><a href="TableLobbyObject.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>