objectdraw
Interface ServerListener


public interface ServerListener

The ServerListener interface specifies what methods an object needs in order to be able to function as a server listener, the object managing a server. The listener will be notified when the server starts and stops, when a channel is opened to a client, and when a message is received from a client. Each channel is given a unique ID number in case you want to send a message just to one client.

To specify what object will be your ServerListener, use the Network.configure() method.

Author:
Russell Zahniser (russell@zahniser.net)
See Also:
Network.configure(String, ServerListener, ClientListener)

Field Summary
static ServerListener ECHO
          If implementing your own server listener is too daunting a task, this one may be all you need.
 
Method Summary
 void channelClosed(Server server, int channelID, String channelName)
          This method will be called when a client disconnects from the server.
 void channelOpened(Server server, int channelID, String channelName)
          This method will be called when a client logs in to the server.
 void messageReceived(Server server, int channelID, String channelName, String message)
          This method will be called when a client sends a message to the server.
 void serverStarted(Server server)
          This method will be called when the server starts
 void serverStopped(Server server)
          This method will be called when the server shuts down.
 

Field Detail

ECHO

static final ServerListener ECHO
If implementing your own server listener is too daunting a task, this one may be all you need. Every time it gets a message, it sends back that same message to all clients. This means that you can essentially ignore the server and assume that sending a message from any client will result in all the client computers (including the sender) getting a messageReceived() event.

Method Detail

channelClosed

void channelClosed(Server server,
                   int channelID,
                   String channelName)
This method will be called when a client disconnects from the server.

Parameters:
server - The server
channelID - Unique ID that will always be used for this client
channelName - Client's name

channelOpened

void channelOpened(Server server,
                   int channelID,
                   String channelName)
This method will be called when a client logs in to the server. The ID numbers assigned for clients will always count up from zero, although occasionally one will be skipped if a client quit the program before fully logging in.

Parameters:
server - The server
channelID - Unique ID that will always be used for this client
channelName - Client's name

messageReceived

void messageReceived(Server server,
                     int channelID,
                     String channelName,
                     String message)
This method will be called when a client sends a message to the server.

Parameters:
server - The server
channelID - Unique ID that will always be used for this client
channelName - Client's name
message - The message that was sent

serverStarted

void serverStarted(Server server)
This method will be called when the server starts

Parameters:
server - The server

serverStopped

void serverStopped(Server server)
This method will be called when the server shuts down.

Parameters:
server - The server