tracks.singleLearning.utils

Class Comm

java.lang.Object

java.lang.Thread

tracks.singleLearning.utils.Comm

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

PipeComm, SocketComm

public abstract class Comm
extends java.lang.Thread

Created by dperez on 01/06/2017.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Types.LEARNING_SSO_TYPE	lastSsoType Variable to store the message type
protected java.lang.String	lineSep Line separator for messages.
protected long	messageId Message ID
protected java.lang.String	TOKEN_SEP Special character to separate message ID from actual message

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
Comm() Default constructor

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	commRecv() Receives a message from the client.
abstract void	commSend(java.lang.String msg) Sends a message through the pipe.
boolean	endComm() This function is called at the end of the whole process.
int	finishGame(StateObservation so) This method is used to set the game state to either "ABORT_STATE" or "END_STATE" depending on the termination of the game.
Types.LEARNING_SSO_TYPE	getLastSsoType()
abstract void	initBuffers() Creates the buffers for communication.
boolean	startComm() This function is called at the beginning of the game for initialization.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

lastSsoType

protected Types.LEARNING_SSO_TYPE lastSsoType

Variable to store the message type

lineSep

protected java.lang.String lineSep

Line separator for messages.

TOKEN_SEP

protected java.lang.String TOKEN_SEP

Special character to separate message ID from actual message

messageId

protected long messageId

Message ID

Constructor Detail

Comm

public Comm()

Default constructor

Method Detail

finishGame

public int finishGame(StateObservation so)

This method is used to set the game state to either "ABORT_STATE" or "END_STATE" depending on the termination of the game. Each game calls this method upon teardown of the player object. END_STATE: Game ends normally ABORT_STATE: Game is violently ended by player using "ABORT" message or ACTION_ESCAPE key

Parameters:

so - State observation of the game in progress to be used for message sending.

Returns:

response by the client (level to be played)

startComm

public boolean startComm()

This function is called at the beginning of the game for initialization. Will give up if no "START_DONE" received after having received 11 responses

endComm

public boolean endComm()

This function is called at the end of the whole process. Closes the communication. Will give up if no "START_DONE" received after having received 11 responses

initBuffers

public abstract void initBuffers()

Creates the buffers for communication.

commRecv

public abstract java.lang.String commRecv()
                                   throws java.io.IOException

Receives a message from the client.

Returns:

the response got from the client, or null if no response was received after due time.

Throws:

java.io.IOException

commSend

public abstract void commSend(java.lang.String msg)
                       throws java.io.IOException

Sends a message through the pipe.

Parameters:

msg - message to send.

Throws:

java.io.IOException

getLastSsoType

public Types.LEARNING_SSO_TYPE getLastSsoType()