Package javacheckers.networking

Class Host

java.lang.Object

javacheckers.networking.Host

Direct Known Subclasses:

CheckersHost

public class Host
extends java.lang.Object

Defines a host object for connecting with clients and passing messages Designed and adapted from the notes here http://math.hws.edu/javanotes/c12/s5.html

Constructor Summary

Constructors

Constructor	Description
Host(int port)	Create a host listening on the specified port, and start the message processing thread.

Method Summary

Modifier and Type	Method	Description
protected void	clientConnected(int clientID)	Called after a new client has connected
protected void	clientDisconnected(int clientID)	Called when a client disconnects
protected void	extraHandshake(int clientID, java.io.ObjectInputStream in, java.io.ObjectOutputStream out)	Called after a connection is received to handle extra set up.
boolean	getAutoreset()	Return the value of the autoreset property
int[]	getClientList()	Get a list of ID numbers of the clients that are currently connected.
protected void	messageReceived(int clientID, java.lang.Object message)	Called when a message is received by a client.
void	resetOutput()	Reset all output streams after any messages currently in the output queue have been sent.
void	restartServer(int port)	Restarts listening and accepting new clients
void	sendToAll(java.lang.Object message)	Sends a specified Object as a message to all connected clients.
boolean	sendToOne(int clientID, java.lang.Object message)	Sends a specified Object as a message to the client with the specified ID.
void	setAutoreset(boolean auto)	If autoreset is set to true, all output streams will be reset before each transmission.
void	shudownHost()	Disconnect all currently connected clients and stop accepting new clients.
void	shutdownServerSocket()	Stops listening without dropping connections.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Host

public Host(int port)
     throws java.io.IOException

Create a host listening on the specified port, and start the message processing thread.

Parameters:

port - The port to listen on

Throws:

java.io.IOException - if it is not possible to create a listening socket on the specified port

Method Detail

messageReceived

protected void messageReceived(int clientID,
                               java.lang.Object message)

Called when a message is received by a client.

Parameters:

clientID - The ID of the client the message is from

message - The actual message that was sent

clientConnected

protected void clientConnected(int clientID)

Called after a new client has connected

Parameters:

clientID - The ID of the new client

clientDisconnected

protected void clientDisconnected(int clientID)

Called when a client disconnects

Parameters:

clientID - The ID of the client that disconnected

extraHandshake

protected void extraHandshake(int clientID,
                              java.io.ObjectInputStream in,
                              java.io.ObjectOutputStream out)
                       throws java.io.IOException

Called after a connection is received to handle extra set up.

Parameters:

clientID - The id of the client to shake hands with

in - The stream from which messages from the client can be read

out - The stream that messages to the client can be sent

Throws:

java.io.IOException - if there is a problem with the connection. The connection will be closed and the client never added to the list.

getClientList

public int[] getClientList()

Get a list of ID numbers of the clients that are currently connected.

Returns:

An array containing the ID numbers of currently connected clients

shutdownServerSocket

public void shutdownServerSocket()

Stops listening without dropping connections. Useful if a max number of connections is reached.

restartServer

public void restartServer(int port)
                   throws java.io.IOException

Restarts listening and accepting new clients

Parameters:

port - The port to listen on

Throws:

java.io.IOException - if it is not possible to create a socket on the specified port

shudownHost

public void shudownHost()

Disconnect all currently connected clients and stop accepting new clients.

sendToAll

public void sendToAll(java.lang.Object message)

Sends a specified Object as a message to all connected clients.

Parameters:

message - The message to send to all clients. It must implement the Serializable interface and must not be null.

sendToOne

public boolean sendToOne(int clientID,
                         java.lang.Object message)

Sends a specified Object as a message to the client with the specified ID.

Parameters:

clientID - The ID of the client to send the message to

message - The message to send to the client. Must implement the serializable interface and must not be null.

Returns:

resetOutput

public void resetOutput()

Reset all output streams after any messages currently in the output queue have been sent. Use this if the same object is sent more than once, and some changes have been made to it.

setAutoreset

public void setAutoreset(boolean auto)

If autoreset is set to true, all output streams will be reset before each transmission.

Parameters:

auto - The value to set autoreset to

getAutoreset

public boolean getAutoreset()

Return the value of the autoreset property

Returns:

The value of the autoreset property