Started work on the 'crowd' package.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3935 542714f4-19e9-0310-aa3c-eee0fc999fb1
2006-03-10 03:05:37 +00:00
parent 3f5aed3555
commit ca66f91ac7
31 changed files with 2650 additions and 57 deletions
@@ -0,0 +1,69 @@
+//
+// $Id: ChatService.java 3310 2005-01-24 23:08:21Z mdb $
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
+// http://www.threerings.net/code/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.crowd.chat.client {
+
+import com.threerings.util.Name;
+
+import com.threerings.presents.client.Client;
+import com.threerings.presents.client.InvocationListener;
+import com.threerings.presents.client.InvocationService;
+
+/**
+ * The chat services provide a mechanism by which the client can broadcast
+ * chat messages to all clients that are subscribed to a particular place
+ * object or directly to a particular client. These services should not be
+ * used directly, but instead should be accessed via the {@link
+ * ChatDirector}.
+ */
+public interface ChatService extends InvocationService
+{
+    /**
+     * Requests that a tell message be delivered to the user with username
+     * equal to <code>target</code>.
+     *
+     * @param client a connected, operational client instance.
+     * @param target the username of the user to which the tell message
+     * should be delivered.
+     * @param message the contents of the message.
+     * @param listener the reference that will receive the tell response.
+     */
+    function tell (
+        client :Client, target :Name, message :String, listener :TellListener)
+        :void;
+
+    /**
+     * Requests that a message be broadcast to all users in the system.
+     *
+     * @param client a connected, operational client instance.
+     * @param message the contents of the message.
+     * @param listener the reference that will receive a failure response.
+     */
+    function broadcast (
+        client :Client, message :String, listener :InvocationListener) :void;
+
+    /**
+     * Sets this client's away message. If the message is null or the
+     * empty string, the away message will be cleared.
+     */
+    function away (client :Client, message :String) :void;
+}
+}