Package javacheckers.networking

Class Client

java.lang.Object

javacheckers.networking.Client

public abstract class Client
extends java.lang.Object

Represents a client that can connnect to a Host

Field Summary

Fields

Modifier and Type	Field	Description
protected int[]	connectedClientIDs	A list of the IDs of all clients who are currently connected to the host.

Constructor Summary

Constructors

Constructor	Description
Client(java.lang.String hostName, int hostPort)	Constructor that creates a connection to the host.

Method Summary

Modifier and Type	Method	Description
protected void	clientConnected(int newPlayerID)	Called when this client is notified that a client has connected to the host.
protected void	clientDisconnected(int departingPlayerID)	Called when this client is notified that another client has disconnected from the host.
protected void	connectionClosedByError(java.lang.String message)	Called when the connection to the host is closed due to an error.
void	disconnect()	Disconnect cleanly from the host.
protected void	extraHandshake(java.io.ObjectInputStream in, java.io.ObjectOutputStream out)	Called after connection to the host is opened and after the client is assigned an ID number.
boolean	getAutoreset()	Return the value of the autoreset property
int	getID()	Return the ID of this client that was assigned when the connection was established.
protected abstract void	messageReceived(java.lang.Object message)	Called when a message is received from the host.
void	resetOutput()	Resets the output stream, after any messages currently in the output queue have been sent.
void	send(java.lang.Object message)	Add a message to the queue to be sent to the host.
protected void	serverShutdown(java.lang.String message)	Called when the connectino to the host is shutdown because the server is shutting down.
void	setAutoreset(boolean auto)	Set the autoreset property, which determines if output streams will be reset before every transmission.

Methods inherited from class java.lang.Object

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

Field Detail

connectedClientIDs

protected int[] connectedClientIDs

A list of the IDs of all clients who are currently connected to the host.

Constructor Detail

Client

public Client(java.lang.String hostName,
              int hostPort)
       throws java.io.IOException

Constructor that creates a connection to the host.

Parameters:

hostName - The ip address of the host

hostPort - The port the host is listening to for connection requests

Throws:

java.io.IOException - if any problems occur when trying to connect

Method Detail

messageReceived

protected abstract void messageReceived(java.lang.Object message)

Called when a message is received from the host. Override this to determine how to respond to messages

Parameters:

message - The received message

clientConnected

protected void clientConnected(int newPlayerID)

Called when this client is notified that a client has connected to the host.

Parameters:

newPlayerID - The ID of the newly connected client

clientDisconnected

protected void clientDisconnected(int departingPlayerID)

Called when this client is notified that another client has disconnected from the host.

Parameters:

departingPlayerID - The ID of the client who has disconnected

connectionClosedByError

protected void connectionClosedByError(java.lang.String message)

Called when the connection to the host is closed due to an error.

Parameters:

message - An error message

serverShutdown

protected void serverShutdown(java.lang.String message)

Called when the connectino to the host is shutdown because the server is shutting down.

Parameters:

message - A good message sent by the host that it is being shutdown properly (without error)

extraHandshake

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

Called after connection to the host is opened and after the client is assigned an ID number. This method does any extra checking or set up before the connection is fully established.

Parameters:

in - A stream that messages from the host can be read from

out - A stream that messages to the host can be sent with

Throws:

java.io.IOException

disconnect

public void disconnect()

Disconnect cleanly from the host.

send

public void send(java.lang.Object message)
          throws java.lang.IllegalArgumentException,
                 java.lang.IllegalStateException

Add a message to the queue to be sent to the host.

Parameters:

message - The Object message to send to the host, must implement Serializable and cannot be null

Throws:

java.lang.IllegalArgumentException - If the message is null or does not implement Serializable

java.lang.IllegalStateException - If the connection to the host is closed

getID

public int getID()

Return the ID of this client that was assigned when the connection was established.

Returns:

The ID of this client

resetOutput

public void resetOutput()

Resets the output stream, after any messages currently in the output queue have been sent. This is used if the same object needs to be sent more than once, and changes have been made to it between transmissions.

setAutoreset

public void setAutoreset(boolean auto)

Set the autoreset property, which determines if output streams will be reset before every transmission. Use this if the same object is going to be continually changed and retransmitted.

Parameters:

auto - True or False

getAutoreset

public boolean getAutoreset()

Return the value of the autoreset property

Returns: