com.lyrisoft.chat.client
Interface IChatClient

All Known Implementing Classes:

DumbClient, Client

public interface IChatClient

The view of the client. This is a sort of call-back interface that the server uses to talk to the client. There is an implementation of this interface on both the server and the client side. On the server side, the implementation's job is to create some kind of message and pass it over the wire. On the client side, the implementation's job is to react somehow (i.e., display a message in a window, or whatever..)

Method Summary

void	ackJoinRoom(java.lang.String room) The server has acknowledged our room join
void	ackKill(java.lang.String victim)
void	ackPartRoom(java.lang.String room) The server has acknowledged our room part
void	ackSignon(java.lang.String myname) The server has authenticated us and acknowledged our sign on
void	connectionLost() The connection to the server was closed
void	emote(java.lang.String from, java.lang.String room, java.lang.String message)
void	emoteFromUserPrivate(java.lang.String user, java.lang.String msg) The server is indicating that someone is privately emoting something to us.
void	generalError(java.lang.String message) The server is giving us an error message to display
void	generalMessage(java.lang.String message) The server is giving us a general message to display.
void	generalRoomMessage(java.lang.String room, java.lang.String message) The server is giving us a message to display in the context of a particular room.
java.lang.Object	getAttribute(java.lang.String name)
IChatServer	getServerInterface()
void	globalUserList(java.lang.String[] users) The server is sending us the global user list
void	init()
void	killed(java.lang.String killer, java.lang.String msg)
void	messageFromUser(java.lang.String user, java.lang.String room, java.lang.String msg) The server is indicating that someone is saying something in a room
void	messageFromUserPrivate(java.lang.String user, java.lang.String msg) The server is indicating that someone is saying something to us, privately
void	ping(java.lang.String user, java.lang.String arg) The server is indicating that somebody ping'ed us.
void	pong(java.lang.String user, java.lang.String arg) The server is giving us the reply to a ping that we already sent out.
void	roomCreated(java.lang.String room)
void	roomDestroyed(java.lang.String room)
void	roomList(java.lang.String[] roomList) The server is sending us a list of rooms
void	roomUserList(java.lang.String room, java.lang.String[] users) The server is sending us the user list for a particular room
void	setApplet(java.applet.Applet a)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setInitialRoom(java.lang.String room)
void	showLogin()
void	userJoinedRoom(java.lang.String user, java.lang.String room) The server is indicating that someone just joined a room we're in.
void	userPartedRoom(java.lang.String user, java.lang.String room, boolean signOff) The server is indicating that someone just parted a room we're in.
void	userSignOff(java.lang.String userId)
void	userSignOn(java.lang.String userId)

Method Detail

ackSignon

public void ackSignon(java.lang.String myname)

The server has authenticated us and acknowledged our sign on

connectionLost

public void connectionLost()

The connection to the server was closed

ackJoinRoom

public void ackJoinRoom(java.lang.String room)

The server has acknowledged our room join

ackPartRoom

public void ackPartRoom(java.lang.String room)

The server has acknowledged our room part

messageFromUser

public void messageFromUser(java.lang.String user,
                            java.lang.String room,
                            java.lang.String msg)

The server is indicating that someone is saying something in a room

messageFromUserPrivate

public void messageFromUserPrivate(java.lang.String user,
                                   java.lang.String msg)

The server is indicating that someone is saying something to us, privately

emoteFromUserPrivate

public void emoteFromUserPrivate(java.lang.String user,
                                 java.lang.String msg)

The server is indicating that someone is privately emoting something to us. (Note, there is no "emoteFromUserPublic"; A public emote comes in as a generalRoomMessage

See Also:

generalRoomMessage(java.lang.String, java.lang.String)

roomList

public void roomList(java.lang.String[] roomList)

The server is sending us a list of rooms

globalUserList

public void globalUserList(java.lang.String[] users)

The server is sending us the global user list

roomUserList

public void roomUserList(java.lang.String room,
                         java.lang.String[] users)

The server is sending us the user list for a particular room

userJoinedRoom

public void userJoinedRoom(java.lang.String user,
                           java.lang.String room)

The server is indicating that someone just joined a room we're in.

userPartedRoom

public void userPartedRoom(java.lang.String user,
                           java.lang.String room,
                           boolean signOff)

The server is indicating that someone just parted a room we're in.

generalError

public void generalError(java.lang.String message)

The server is giving us an error message to display

generalMessage

public void generalMessage(java.lang.String message)

The server is giving us a general message to display. (This could be a MOTD or the answer to some general request like the /stats command)

generalRoomMessage

public void generalRoomMessage(java.lang.String room,
                               java.lang.String message)

The server is giving us a message to display in the context of a particular room. This is commonly an emote message.

ping

public void ping(java.lang.String user,
                 java.lang.String arg)

The server is indicating that somebody ping'ed us. It expects to get a pong message back

pong

public void pong(java.lang.String user,
                 java.lang.String arg)

The server is giving us the reply to a ping that we already sent out.

killed

public void killed(java.lang.String killer,
                   java.lang.String msg)

ackKill

public void ackKill(java.lang.String victim)

emote

public void emote(java.lang.String from,
                  java.lang.String room,
                  java.lang.String message)

userSignOn

public void userSignOn(java.lang.String userId)

userSignOff

public void userSignOff(java.lang.String userId)

roomCreated

public void roomCreated(java.lang.String room)

roomDestroyed

public void roomDestroyed(java.lang.String room)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

init

public void init()

setApplet

public void setApplet(java.applet.Applet a)

setInitialRoom

public void setInitialRoom(java.lang.String room)

showLogin

public void showLogin()

getServerInterface

public IChatServer getServerInterface()