Michael Bayne
dd4b1c69c3
git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@1875 542714f4-19e9-0310-aa3c-eee0fc999fb1
59 lines
2.0 KiB
Java
59 lines
2.0 KiB
Java
//
|
|
// $Id: ChatService.java,v 1.10 2002/10/31 23:27:16 mdb Exp $
|
|
|
|
package com.threerings.crowd.chat;
|
|
|
|
import com.threerings.presents.client.Client;
|
|
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
|
|
{
|
|
/**
|
|
* Used to communicate the response to a {@link #tell} request.
|
|
*/
|
|
public static interface TellListener extends InvocationListener
|
|
{
|
|
/**
|
|
* Communicates the response to a {@link #tell} request.
|
|
*/
|
|
public void tellSucceeded ();
|
|
|
|
/**
|
|
* Communicates the response to a {@link #tell} request.
|
|
*
|
|
* @param idletime, the number of ms the tellee has been idle.
|
|
*/
|
|
public void tellSucceededIdle (long idletime);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public void tell (Client client, String target, String message,
|
|
TellListener listener);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public void broadcast (Client client, String message,
|
|
InvocationListener listener);
|
|
}
|