io.github.robolib.nettable

Class NTConnectionAdapter

java.lang.Object

io.github.robolib.nettable.NTConnectionAdapter

public class NTConnectionAdapter
extends java.lang.Object

Object that adapts messages from a client to the server

Field Summary

Fields

Modifier and Type	Field and Description
private NTConnectionList	m_adapterListener
NTConnection	m_connection
private NTConnectionState	m_connectionState
private NTEntryStore	m_entryStore
private NTThread	m_readThread

Constructor Summary

Constructors

Constructor and Description
NTConnectionAdapter(NTSocketStream stream, NTEntryStore entryStore, NTConnectionList adapterListener, NTEntryTypeManager typeManager) Create a server connection adapter for a given stream

Method Summary

Modifier and Type	Method and Description
void	badMessage(BadMessageException e) called if a bad message exception is thrown
void	clientHello(char protocolRevision) Called when the connection receives a client hello message
void	ensureAlive()
void	flush()
NTConnectionState	getConnectionState()
NTTableEntry	getEntry(char id) get an entry (used by a connection when filling an update entry
private void	gotoState(NTConnectionState newState)
void	ioException(java.io.IOException e) called if an io exception is thrown
void	keepAlive() Called when the connection receives a keep alive message
void	offerIncomingAssignment(NTTableEntry entry)
void	offerIncomingUpdate(NTTableEntry entry, char sequenceNumber, java.lang.Object value)
void	offerOutgoingAssignment(NTTableEntry entry)
void	offerOutgoingUpdate(NTTableEntry entry)
void	protocolVersionUnsupported(char protocolRevision) Called when the connection receives a protocol unsupported message
void	serverHelloComplete()
void	shutdown(boolean closeStream) stop the read thread and close the stream

Methods inherited from class java.lang.Object

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

Field Detail

m_entryStore

private final NTEntryStore m_entryStore

m_adapterListener

private final NTConnectionList m_adapterListener

m_connection

public final NTConnection m_connection

m_readThread

private final NTThread m_readThread

m_connectionState

private NTConnectionState m_connectionState

Constructor Detail

NTConnectionAdapter

public NTConnectionAdapter(NTSocketStream stream,
                           NTEntryStore entryStore,
                           NTConnectionList adapterListener,
                           NTEntryTypeManager typeManager)

Create a server connection adapter for a given stream

Parameters:

stream -

transactionPool -

entryStore -

transactionReceiver -

adapterListener -

threadManager -

Method Detail

gotoState

private void gotoState(NTConnectionState newState)

badMessage

public void badMessage(BadMessageException e)

called if a bad message exception is thrown

Parameters:

e -

ioException

public void ioException(java.io.IOException e)

called if an io exception is thrown

Parameters:

e -

shutdown

public void shutdown(boolean closeStream)

stop the read thread and close the stream

keepAlive

public void keepAlive()
               throws java.io.IOException

Called when the connection receives a keep alive message

Throws:

java.io.IOException

clientHello

public void clientHello(char protocolRevision)
                 throws java.io.IOException

Called when the connection receives a client hello message

Parameters:

protocolRevision -

Throws:

java.io.IOException

protocolVersionUnsupported

public void protocolVersionUnsupported(char protocolRevision)
                                throws java.io.IOException

Called when the connection receives a protocol unsupported message

Parameters:

protocolRevision - the protocol version the server reported it supports

Throws:

java.io.IOException

serverHelloComplete

public void serverHelloComplete()
                         throws java.io.IOException

Throws:

java.io.IOException

offerIncomingAssignment

public void offerIncomingAssignment(NTTableEntry entry)

offerIncomingUpdate

public void offerIncomingUpdate(NTTableEntry entry,
                                char sequenceNumber,
                                java.lang.Object value)

getEntry

public NTTableEntry getEntry(char id)

get an entry (used by a connection when filling an update entry

Parameters:

id -

Returns:

the entry or null if the entry does not exist

offerOutgoingAssignment

public void offerOutgoingAssignment(NTTableEntry entry)

offerOutgoingUpdate

public void offerOutgoingUpdate(NTTableEntry entry)

flush

public void flush()

getConnectionState

public NTConnectionState getConnectionState()

Returns:

the state of the connection

ensureAlive

public void ensureAlive()