AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ccf127a3bbec367664de38da118dbb6f2fd1d465
vilya/apidocs/com/threerings/parlor/server/ParlorManager.html
T
Michael Bayne ccf127a3bb API docs for 1.3 release.
2011-04-06 17:01:15 -07:00

497 lines
32 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>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Wed Apr 06 17:00:10 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
ParlorManager (vilya 1.3 API)
</TITLE>
<META NAME="date" CONTENT="2011-04-06">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ParlorManager (vilya 1.3 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ParlorManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/threerings/parlor/server/ParlorManager.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ParlorManager.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.threerings.parlor.server</FONT>
<BR>
Class ParlorManager</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.threerings.parlor.server.ParlorManager</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</A>, <A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</A>, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>ParlorManager</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</A>, <A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</A></DL>
</PRE>
<P>
The parlor manager is responsible for the parlor services in aggregate. This includes
maintaining the registry of active games, handling the necessary coordination for the
matchmaking services and anything else that falls outside the scope of an actual in-progress
game.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_com.threerings.parlor.data.ParlorCodes"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface com.threerings.parlor.data.<A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#ALREADY_AT_TABLE">ALREADY_AT_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#BANNED_FROM_TABLE">BANNED_FROM_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#GAME_ALREADY_STARTED">GAME_ALREADY_STARTED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVALID_TABLE_POSITION">INVALID_TABLE_POSITION</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_ACCEPTED">INVITATION_ACCEPTED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_COUNTERED">INVITATION_COUNTERED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_REFUSED">INVITATION_REFUSED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITEE_NOT_ONLINE">INVITEE_NOT_ONLINE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#MUST_BE_CREATOR">MUST_BE_CREATOR</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#NO_SELF_BOOT">NO_SELF_BOOT</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#NO_SUCH_TABLE">NO_SUCH_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#NOT_AT_TABLE">NOT_AT_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#PARLOR_GROUP">PARLOR_GROUP</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#TABLE_POSITION_OCCUPIED">TABLE_POSITION_OCCUPIED</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_com.threerings.presents.data.InvocationCodes"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface com.threerings.presents.data.InvocationCodes</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#ParlorManager(com.threerings.presents.server.InvocationManager)">ParlorManager</A></B>(com.threerings.presents.server.InvocationManager&nbsp;invmgr)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#cancel(com.threerings.presents.data.ClientObject, int, com.threerings.presents.client.InvocationService.InvocationListener)">cancel</A></B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;inviteId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)"><CODE>ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)</CODE></A> request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#cancelInvite(com.threerings.crowd.data.BodyObject, int)">cancelInvite</A></B>(com.threerings.crowd.data.BodyObject&nbsp;source,
int&nbsp;inviteId)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that an outstanding invitation be cancelled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#invite(com.threerings.crowd.data.BodyObject, com.threerings.crowd.data.BodyObject, com.threerings.parlor.game.data.GameConfig)">invite</A></B>(com.threerings.crowd.data.BodyObject&nbsp;inviter,
com.threerings.crowd.data.BodyObject&nbsp;invitee,
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A>&nbsp;config)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Issues an invitation from the <code>inviter</code> to the <code>invitee</code> for a game as
described by the supplied config object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#invite(com.threerings.presents.data.ClientObject, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)">invite</A></B>(com.threerings.presents.data.ClientObject&nbsp;caller,
com.threerings.util.Name&nbsp;invitee,
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A>&nbsp;config,
<A HREF="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</A>&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)"><CODE>ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)</CODE></A> request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#respond(com.threerings.presents.data.ClientObject, int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)">respond</A></B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;inviteId,
int&nbsp;code,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)"><CODE>ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)</CODE></A> request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#respondToInvite(com.threerings.crowd.data.BodyObject, int, int, java.lang.Object)">respondToInvite</A></B>(com.threerings.crowd.data.BodyObject&nbsp;source,
int&nbsp;inviteId,
int&nbsp;code,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Effects a response to an invitation (accept, refuse or counter), made by the specified
source user with the specified arguments.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/server/ParlorManager.html#startSolitaire(com.threerings.presents.data.ClientObject, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)">startSolitaire</A></B>(com.threerings.presents.data.ClientObject&nbsp;caller,
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A>&nbsp;config,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)"><CODE>ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)</CODE></A> request.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ParlorManager(com.threerings.presents.server.InvocationManager)"><!-- --></A><H3>
ParlorManager</H3>
<PRE>
<FONT SIZE="-1">@Inject
</FONT>public <B>ParlorManager</B>(com.threerings.presents.server.InvocationManager&nbsp;invmgr)</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="invite(com.threerings.presents.data.ClientObject, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)"><!-- --></A><H3>
invite</H3>
<PRE>
public void <B>invite</B>(com.threerings.presents.data.ClientObject&nbsp;caller,
com.threerings.util.Name&nbsp;invitee,
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A>&nbsp;config,
<A HREF="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</A>&nbsp;listener)
throws com.threerings.presents.server.InvocationException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#invite(com.threerings.presents.data.ClientObject, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)">ParlorProvider</A></CODE></B></DD>
<DD>Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)"><CODE>ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)</CODE></A> request.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#invite(com.threerings.presents.data.ClientObject, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)">invite</A></CODE> in interface <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>com.threerings.presents.server.InvocationException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="respond(com.threerings.presents.data.ClientObject, int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)"><!-- --></A><H3>
respond</H3>
<PRE>
public void <B>respond</B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;inviteId,
int&nbsp;code,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#respond(com.threerings.presents.data.ClientObject, int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)">ParlorProvider</A></CODE></B></DD>
<DD>Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)"><CODE>ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)</CODE></A> request.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#respond(com.threerings.presents.data.ClientObject, int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)">respond</A></CODE> in interface <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="cancel(com.threerings.presents.data.ClientObject, int, com.threerings.presents.client.InvocationService.InvocationListener)"><!-- --></A><H3>
cancel</H3>
<PRE>
public void <B>cancel</B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;inviteId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#cancel(com.threerings.presents.data.ClientObject, int, com.threerings.presents.client.InvocationService.InvocationListener)">ParlorProvider</A></CODE></B></DD>
<DD>Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)"><CODE>ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)</CODE></A> request.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#cancel(com.threerings.presents.data.ClientObject, int, com.threerings.presents.client.InvocationService.InvocationListener)">cancel</A></CODE> in interface <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="startSolitaire(com.threerings.presents.data.ClientObject, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)"><!-- --></A><H3>
startSolitaire</H3>
<PRE>
public void <B>startSolitaire</B>(com.threerings.presents.data.ClientObject&nbsp;caller,
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A>&nbsp;config,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)
throws com.threerings.presents.server.InvocationException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#startSolitaire(com.threerings.presents.data.ClientObject, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)">ParlorProvider</A></CODE></B></DD>
<DD>Handles a <A HREF="../../../../com/threerings/parlor/client/ParlorService.html#startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)"><CODE>ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)</CODE></A> request.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html#startSolitaire(com.threerings.presents.data.ClientObject, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)">startSolitaire</A></CODE> in interface <CODE><A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>com.threerings.presents.server.InvocationException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="invite(com.threerings.crowd.data.BodyObject, com.threerings.crowd.data.BodyObject, com.threerings.parlor.game.data.GameConfig)"><!-- --></A><H3>
invite</H3>
<PRE>
public int <B>invite</B>(com.threerings.crowd.data.BodyObject&nbsp;inviter,
com.threerings.crowd.data.BodyObject&nbsp;invitee,
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A>&nbsp;config)
throws com.threerings.presents.server.InvocationException</PRE>
<DL>
<DD>Issues an invitation from the <code>inviter</code> to the <code>invitee</code> for a game as
described by the supplied config object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>inviter</CODE> - the player initiating the invitation.<DD><CODE>invitee</CODE> - the player being invited.<DD><CODE>config</CODE> - the configuration of the game being proposed.
<DT><B>Returns:</B><DD>the invitation identifier for the newly created invitation record.
<DT><B>Throws:</B>
<DD><CODE>com.threerings.presents.server.InvocationException</CODE> - thrown if the invitation was not able to be processed for
some reason (like the invited player has requested not to be disturbed). The explanation
will be provided in the message data of the exception.</DL>
</DD>
</DL>
<HR>
<A NAME="respondToInvite(com.threerings.crowd.data.BodyObject, int, int, java.lang.Object)"><!-- --></A><H3>
respondToInvite</H3>
<PRE>
public void <B>respondToInvite</B>(com.threerings.crowd.data.BodyObject&nbsp;source,
int&nbsp;inviteId,
int&nbsp;code,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg)</PRE>
<DL>
<DD>Effects a response to an invitation (accept, refuse or counter), made by the specified
source user with the specified arguments.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - the body object of the user that is issuing this response.<DD><CODE>inviteId</CODE> - the identifier of the invitation to which we are responding.<DD><CODE>code</CODE> - the response code (either <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_ACCEPTED"><CODE>ParlorCodes.INVITATION_ACCEPTED</CODE></A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_REFUSED"><CODE>ParlorCodes.INVITATION_REFUSED</CODE></A> or <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_COUNTERED"><CODE>ParlorCodes.INVITATION_COUNTERED</CODE></A>).<DD><CODE>arg</CODE> - the argument that goes along with the response: an explanatory message in the
case of a refusal (the empty string, not null, if no message was provided) or the new game
configuration in the case of a counter-invitation.</DL>
</DD>
</DL>
<HR>
<A NAME="cancelInvite(com.threerings.crowd.data.BodyObject, int)"><!-- --></A><H3>
cancelInvite</H3>
<PRE>
public void <B>cancelInvite</B>(com.threerings.crowd.data.BodyObject&nbsp;source,
int&nbsp;inviteId)</PRE>
<DL>
<DD>Requests that an outstanding invitation be cancelled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - the body object of the user that is making the request.<DD><CODE>inviteId</CODE> - the unique id of the invitation to be cancelled.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ParlorManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/threerings/parlor/server/ParlorManager.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ParlorManager.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2011. All Rights Reserved.
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink