org.deken.game.io
Class AbstractConnection

java.lang.Object
  extended by org.deken.game.io.AbstractConnection

public abstract class AbstractConnection
extends java.lang.Object

Title: AbstractConnection

Description: An abstract class to set up basic connections protocals and code, required for connections.

Copyright: Copyright (c) 2006

Version:
1.0
Author:
Gary Deken

Field Summary
 java.lang.String DELIMITER
           
static java.lang.String END_OF_TRANSMISSION
           
protected  java.io.BufferedReader in
           
protected  java.lang.String message
           
protected  java.io.PrintStream out
           
protected  java.net.Socket socket
           
 
Constructor Summary
AbstractConnection(java.net.Socket clientSocket)
          AbstractConnection
 
Method Summary
 void close(boolean ioError)
          close
 java.lang.String getMessage()
          getMessage
 java.lang.String getMessageHeader()
          getMessageHeader
protected  boolean open()
           
protected  void receive()
          receive
protected  void send(java.lang.String header, java.lang.String message)
           
 void setMessage(java.lang.String message)
          setMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

END_OF_TRANSMISSION

public static final java.lang.String END_OF_TRANSMISSION
See Also:
Constant Field Values

DELIMITER

public final java.lang.String DELIMITER
See Also:
Constant Field Values

socket

protected java.net.Socket socket

message

protected java.lang.String message

in

protected java.io.BufferedReader in

out

protected java.io.PrintStream out
Constructor Detail

AbstractConnection

public AbstractConnection(java.net.Socket clientSocket)
AbstractConnection

Parameters:
clientSocket - Socket
Method Detail

close

public final void close(boolean ioError)
close

Set boolean to true if there was an IOError, otherwise set to false.

Parameters:
ioError - boolean

setMessage

public void setMessage(java.lang.String message)
setMessage

Parameters:
message - String

getMessageHeader

public java.lang.String getMessageHeader()
getMessageHeader

Returns the header for this message.

Returns:
String

getMessage

public java.lang.String getMessage()
getMessage

Returns:
String

open

protected boolean open()

send

protected void send(java.lang.String header,
                    java.lang.String message)

receive

protected void receive()
receive

Attempts to recieve the message from the Input Stream, and stores it in the class variable message.