de.morknet.mrw.comm

Class Connection

java.lang.Object

de.morknet.mrw.comm.Connection

Direct Known Subclasses:

DummyConnection, RS232Connection, TcpConnection

public abstract class Connection
extends java.lang.Object

Diese Klasse repräsentiert eine Kommunikationsverbindung zu einer Eisenbahnanlage.

Author:

sm

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteProcessor	processor Die Verbindung zur Auswertung einzelner Bytes.

Constructor Summary

Constructors

Constructor and Description
Connection()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Diese Methode baut die Kommunikationsverbindung wieder ab.
static Connection	getDefaultConnection() Diese Methode öffnet die konfigurierte Default-Verbindung.
protected byte[]	getSyncSequence() Diese Methode gibt die Bytesequenz zurück, mit der das CAN-Gateway synchronisiert wird.
protected void	handleChecksumException(ChecksumException ce) Diese Methode macht die Fehlerbehandlung im Falle eines Prüfsummenfehlers.
boolean	isReal() Diese Methode liefert zurück, ob eine reale Verbindung zu einer Modelleisenbahn besteht.
abstract int	read() Diese Methode liest ein einzelnes Byte über diese Verbindung ein.
void	setByteProcessor(ByteProcessor processor) Diese Methode setzt die Klasse, die die über diese Connection empfagnenen Bytes auswertet.
protected abstract void	start() Diese Methode wird aufgerufen, wenn die Methode setByteProcessor(ByteProcessor) einen ByteProcessor setzt, der ungleich null ist.
protected abstract void	stop() Diese Methode wird aufgerufen, wenn die Methode setByteProcessor(ByteProcessor) einen ByteProcessor setzt, der gleich null ist.
void	sync() Diese Methode sendet eine spezielle Bytesequenz über die Verbindung, um eine synchronisierte Verbindung herzustellen.
abstract void	write(byte[] bytes) Diese Methode schreibt ein Array aus Bytes über die Kommunikationsverbindung.
abstract void	write(int i) Diese Methode schreibt ein einzelnes Byte über die Kommunikationsverbindung.

Methods inherited from class java.lang.Object

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

Field Detail

processor

protected ByteProcessor processor

Die Verbindung zur Auswertung einzelner Bytes.

Constructor Detail

Connection

public Connection()

Method Detail

getDefaultConnection

public static Connection getDefaultConnection()

Diese Methode öffnet die konfigurierte Default-Verbindung.

Returns:

Eine Verbindungsinstanz dieser Klasse.

Throws:

java.lang.Exception - Wird geworfen, falls was fehlerhaft verlaufen ist.

isReal

public boolean isReal()

Diese Methode liefert zurück, ob eine reale Verbindung zu einer Modelleisenbahn besteht. Auch eine reale Verbindung kann hier false liefern, wenn die Verbindung z.B. schon abgebaut ist. Es muss also eine physikalische Verbindung bestehen und diese muss auch initialisiert und aktiv sein.

Returns:

Zustand über reale Verbindung zur Modelleisenbahn.

sync

public void sync()
          throws java.io.IOException

Diese Methode sendet eine spezielle Bytesequenz über die Verbindung, um eine synchronisierte Verbindung herzustellen.

Throws:

java.io.IOException - Wird geworfen, falls ein Verbindungsfehler aufgetreten ist.

setByteProcessor

public void setByteProcessor(ByteProcessor processor)

Diese Methode setzt die Klasse, die die über diese Connection empfagnenen Bytes auswertet.

Parameters:

processor - Die Auswerteklasse für empfangene Bytes.

start

protected abstract void start()

Diese Methode wird aufgerufen, wenn die Methode setByteProcessor(ByteProcessor) einen ByteProcessor setzt, der ungleich null ist. Dadurch soll das Verarbeiten von Bytes seinen Betrieb aufnehmen.

stop

protected abstract void stop()

Diese Methode wird aufgerufen, wenn die Methode setByteProcessor(ByteProcessor) einen ByteProcessor setzt, der gleich null ist. Dadurch soll das Verarbeiten von eingehenden Bytes abgeschaltet werden.

getSyncSequence

protected byte[] getSyncSequence()

Diese Methode gibt die Bytesequenz zurück, mit der das CAN-Gateway synchronisiert wird.

Returns:

Die Bytesequenz zum Synchronisieren des CAN-Gateways.

handleChecksumException

protected void handleChecksumException(ChecksumException ce)
                                throws java.io.IOException

Diese Methode macht die Fehlerbehandlung im Falle eines Prüfsummenfehlers. Dabei wird eine Resynchronisation der Verbindung ausgeführt.

Parameters:

ce - Die auslösende ChecksumException.

Throws:

java.io.IOException - Wird geworfen, wenn die Resynchronisation fehlschlägt.

read

public abstract int read()
                  throws java.io.IOException

Diese Methode liest ein einzelnes Byte über diese Verbindung ein.

Returns:

Das gelesene Byte

Throws:

java.io.IOException - Diese Exception wird geworfen, wenn das Lesen fehlschlug.

write

public abstract void write(int i)
                    throws java.io.IOException

Diese Methode schreibt ein einzelnes Byte über die Kommunikationsverbindung.

Parameters:

i - Das zu schreibende Byte.

Throws:

java.io.IOException - Diese Exception wird geworfen, wenn das Schreiben fehlschlug.

write

public abstract void write(byte[] bytes)
                    throws java.io.IOException

Diese Methode schreibt ein Array aus Bytes über die Kommunikationsverbindung.

Parameters:

bytes - Die zu schreibenden Bytes.

Throws:

java.io.IOException - Diese Exception wird geworfen, wenn das Schreiben fehlschlug.

close

public abstract void close()

Diese Methode baut die Kommunikationsverbindung wieder ab.