LowLevelCommunicationInterface
public class LowLevelCommunication extends java.lang.Object implements LowLevelCommunicationInterface
Die Aufgabe dieser Klasse ist es Telegramme zu versenden, zu empfangen und KeepAlive-Mechanismus zu verwalten.
Jede dieser Aufgaben wird durch mindestens einen Thread übernommen:
Empfang von Daten: ReceivingChannel (nimmt die Daten entgegen und legt diese in _receivingTable ab. Bei Konfigurationsanfragen kann es zur Zerstücklung von Telegrammen kommen, diese Teiltelgramme werden in _splittedTelegramsTable abgelegt und dort mit jedem empfang eines Teiltelegramms langsam zusammen gebaut und nach Vollendung an ClientHighLevelCommunication durchgereicht (nicht über den Worker-Thread). Beim empfang von Daten wird der KeepAlive-Thread benachrichtigt.), WorkerThread (bearbeitet die _receivingTable und reicht empfangene Telegramme an ClientHighLevelCommunication weiter).
Versand von Daten: SendingChannel (verschickt Telegramme aus der _sendingTable und benachrichtigt den KeepAlive Thread, sobald Daten verschickt wurden. Prüft die Laufzeit der einzelnen Telegramme und unterbricht die Verbindung sobald diese einen kritischen Wert unterschreitet).
KeepAlive-Mechanismus: KeepAliveThread (Verwaltet ob ein "KeepAlive" Telegramm verschickt werden muss. Dies ist abhängig davon, ob eine Telegramm versendet/empfangen wurde. Wurde eine bestimmte Anzahl Keepalive Telegramme versendet, so wird die Verbindung abgebaut. Wird nach dem versand eines KeepAlive Telegramms ein normales Telegramm empfangen/gesendet, so wird der KeepAlive-Telegrammzähler wieder auf 0 gesetzt. Anmerkung: Das KeepAlive Paket wird nicht über den SendingChannel-Thread verschickt, sondern direkt über den Outputstream.)
Alle vollständigen Telegramme werden in zwei TelegramQueue-Objekten gespeichert (eine für den Empfang, eine für den Versand). Die oben beschriebenen Threads (ausser der KeepAlive-Thread) arbeiten und synchronisieren sich auf den jeweiligen "PriorityTables".
Begriffsdefinitionen: Protokollsteuerung DaV-DAF (Klasse ClientHighLevelCommunication), Datenrepräsentation (Klassen DataInputStream und DataOutputStream), TCP-Kommunikationskanal (Klasse TCP_IP_Communication)
Modifier and Type | Field | Description |
---|---|---|
static byte |
HANDLE_CONFIG_RESPONCES_MODE |
Wert für den
mode -Parameter des Konstruktors, der bewirkt, dass Konfigurationsantworten ausgewertet und entsprechend an die höhere
Kommunikationsebene weitergegeben werden. |
static byte |
NORMAL_MODE |
Wert für den
mode -Parameter des Konstruktors, der bewirkt, dass Konfigurationsantworten wie normale Datentelegramme verarbeitet werden. |
Constructor | Description |
---|---|
LowLevelCommunication(ConnectionInterface connection,
int sendBufferSize,
int receiveBufferSize,
long keepAliveSendTimeOut,
long keepAliveReceiveTimeOut,
byte mode,
boolean connected) |
Modifier and Type | Method | Description |
---|---|---|
void |
connect(java.lang.String mainAddress,
int subAddress) |
Diese Methode baut eine Kommunikationsverbindung zu den angegebenen Adressen auf.
|
void |
disableEncryption() |
Deaktiviert die Verschlüsselung
|
void |
disconnect(boolean error,
java.lang.String message,
DataTelegram terminationTelegram) |
Diese Methode wird von der Protokollschicht DaV-DAF aufgerufen, wenn die Kommunikationskanäle geschlossen werden sollen.
|
void |
enableEncryption(SrpTelegramEncryption encryption) |
Aktiviert die Verschlüsselung
|
ConnectionInterface |
getConnectionInterface() |
Gibt den Repräsentant der Verbindung zurück
|
EncryptionStatus |
getEncryptionStatus() |
Gibt den Verschlüsselungsstatus zurück
|
HighLevelCommunicationCallbackInterface |
getHighLevelComponent() |
|
java.lang.String |
getSendBufferState() |
Liefert einen beschreibenden Text mit dem Zustand des Sendepuffers
|
boolean |
isNotConnected() |
Gibt als Information zurück, ob die Kommunikationsverbindung unterbrochen ist.
|
void |
send(DataTelegram telegram) |
Diese Methode wird von der Protokollschicht DaV-DAF aufgerufen, wenn ein Telegramm gesendet werden soll.
|
void |
send(DataTelegram[] telegrams) |
Fügt mehrere Telegramme in die Sendetabelle ein.
|
void |
sendDirect(DataTelegram telegram) |
Sendet ein Telegramm direkt, wobei die SendeQueue umgangen wird.
|
void |
sendDirect(java.util.Collection<DataTelegram> telegrams) |
Sendet Telegramme direkt, wobei die SendeQueue umgangen wird.
|
void |
setHighLevelComponent(HighLevelCommunicationCallbackInterface highLevelComponent) |
Setzt die Interpretationsschicht dieser Komponente für den internen Datenaustausch.
|
void |
setRemoteAddress(java.lang.String remoteAddress,
int remotePort) |
|
void |
setRemoteName(java.lang.String name) |
Diese Methode setzt den Namen des Kommunikationspartners, der für Fehlermeldungen etc. verwendet wird.
|
java.lang.String |
toString() |
|
void |
updateKeepAliveParameters(long keepAliveSendTimeOut,
long keepAliveReceiveTimeOut) |
Diese Methode wird von der Protokollschicht DaV-DAF aufgerufen, wenn die Keepalive-Parameter-Verhandlung erfolgreich abgeschlossen ist und setzt somit die
Timeouts des Keepaliveprozesses.
|
void |
updateThroughputParameters(float throughputControlSendBufferFactor,
long throughputControlInterval,
int minimumThroughput) |
Diese Methode setzt die Parameter für die Durchsatzprüfung.
|
public static final byte NORMAL_MODE
mode
-Parameter des Konstruktors, der bewirkt, dass Konfigurationsantworten wie normale Datentelegramme verarbeitet werden.public static final byte HANDLE_CONFIG_RESPONCES_MODE
mode
-Parameter des Konstruktors, der bewirkt, dass Konfigurationsantworten ausgewertet und entsprechend an die höhere
Kommunikationsebene weitergegeben werden.public LowLevelCommunication(ConnectionInterface connection, int sendBufferSize, int receiveBufferSize, long keepAliveSendTimeOut, long keepAliveReceiveTimeOut, byte mode, boolean connected) throws ConnectionException
connection
- Verbindungsobjekt über dass die Kommunikation mit dem Kommunikationspartner realisiert wird.sendBufferSize
- Sendetabellenkapazität (in Byte)receiveBufferSize
- Empfangstabellenkapazität (in Byte)keepAliveSendTimeOut
- Zeitspanne in ms. Wird solange kein Telegramm verschickt, wird ein KeepAlive-Telegramm verschickt.keepAliveReceiveTimeOut
- Zeitspanne in ms. Wird solange keine Telegramm empfangen, wird ein Zähler herabgesetzt. Erreicht der Zähler 0 wird die
Verbindung terminiert. Wird zwischendurch ein Telegramm empfangen, wird der Zähler auf das maximum gesetzt.mode
- Modus für das Konfigurationsdatenverhalten. Falls hier der Wert HANDLE_CONFIG_RESPONCES_MODE
übergeben wird, dann
werden Konfigurationsantworten ausgewertet und entsprechend an die höhere Kommunikationsebene weitergegeben. Falls hier der
Wert NORMAL_MODE
übergeben wird, dann werden Konfigurationsantworten wie normale Datentelegramme verarbeitet.connected
- Information, ob die Verbindung bereits erfolgt ist oder nicht (connected)ConnectionException
- Wenn das Verbindungsobjekt sich nicht im erwarteten Zustand befindet.public final ConnectionInterface getConnectionInterface()
LowLevelCommunicationInterface
getConnectionInterface
in interface LowLevelCommunicationInterface
public final void setHighLevelComponent(HighLevelCommunicationCallbackInterface highLevelComponent)
LowLevelCommunicationInterface
setHighLevelComponent
in interface LowLevelCommunicationInterface
highLevelComponent
- Komponente, die benachrichtigt werden muss, wenn neue Nachrichten empfangen werden.public HighLevelCommunicationCallbackInterface getHighLevelComponent()
public final void updateKeepAliveParameters(long keepAliveSendTimeOut, long keepAliveReceiveTimeOut)
LowLevelCommunicationInterface
updateKeepAliveParameters
in interface LowLevelCommunicationInterface
keepAliveSendTimeOut
- SendekeepalivetimeoutkeepAliveReceiveTimeOut
- Empfangekeepalivetimeoutpublic final void updateThroughputParameters(float throughputControlSendBufferFactor, long throughputControlInterval, int minimumThroughput)
LowLevelCommunicationInterface
updateThroughputParameters
in interface LowLevelCommunicationInterface
throughputControlSendBufferFactor
- Füllungsgrad des Sendepuffers als Faktor zwischen 0 und 1, ab dem die Durchsatzprüfung anfängt zu arbeiten.throughputControlInterval
- Zeit zwischen zwei Durchsatzprüfungen in MillisekundenminimumThroughput
- Minimal zulässiger Verbindungsdurchsatz in Bytes pro Sekundepublic final void connect(java.lang.String mainAddress, int subAddress) throws ConnectionException
Nach dem Verbindungsaufbau werden die Referenzen auf den Sende- und den Empfangskanal festgehalten. Diese werden von den Threads benutzt um Daten zu senden oder empfangen.
connect
in interface LowLevelCommunicationInterface
mainAddress
- Adresse des Kommunikationspartners dieser Verbindung.subAddress
- Subadresse der Adresse.ConnectionException
- Falls die Verbindung nicht hergestellt werden kann.public final boolean isNotConnected()
LowLevelCommunicationInterface
isNotConnected
in interface LowLevelCommunicationInterface
true
= Es besteht keine Verbindung; false
= sonstpublic final void send(DataTelegram telegram)
Fügt ein Telegramm in die Sendetabelle ein.
send
in interface LowLevelCommunicationInterface
telegram
- Das zu versendende Telegramm.public final void send(DataTelegram[] telegrams)
LowLevelCommunicationInterface
send
in interface LowLevelCommunicationInterface
telegrams
- Die zu versendenden Telegramme.LowLevelCommunicationInterface.send(de.bsvrz.dav.daf.communication.lowLevel.telegrams.DataTelegram)
public final void disconnect(boolean error, java.lang.String message, DataTelegram terminationTelegram)
Zunächst wird der Empfangsthread geschlossen; dadurch werden keine Daten mehr empfangen. Danach wird der Keep-alive-Thread geschlossen. Daraufhin wird gewartet, bis der Sendethread alle Telegramme aus der Sendetabelle gesendet hat, damit keine Daten verloren gehen. Anschließend wird der Sendethread beendet. Zuletzt werden die Kommunikationskanäle geschlossen.
disconnect
in interface LowLevelCommunicationInterface
error
- Besagt, ob es sich um eine Terminierung mit Fehler handelt. Falls true
werden sämtliche noch zum Versand gepufferten Telegramme
verworfen; falls false
wird versucht, sämtliche zum Versand gepufferten Telegramme zu versenden.message
- Ursache der Terminierung im Fehlerfall.terminationTelegram
- Das Telegramm, dass als letztes Telegramm vor dem Schließen der Verbindung versendet werden soll oder null
, falls
kein abschließendes Telegramm versendet werden soll.public java.lang.String getSendBufferState()
LowLevelCommunicationInterface
getSendBufferState
in interface LowLevelCommunicationInterface
public void setRemoteName(java.lang.String name)
LowLevelCommunicationInterface
setRemoteName
in interface LowLevelCommunicationInterface
name
- Name oder Identifikation des Kommunikationspartnerspublic final void setRemoteAddress(java.lang.String remoteAddress, int remotePort)
public void enableEncryption(SrpTelegramEncryption encryption)
LowLevelCommunicationInterface
enableEncryption
in interface LowLevelCommunicationInterface
encryption
- Verschlüsselungpublic void disableEncryption()
LowLevelCommunicationInterface
disableEncryption
in interface LowLevelCommunicationInterface
public EncryptionStatus getEncryptionStatus()
LowLevelCommunicationInterface
getEncryptionStatus
in interface LowLevelCommunicationInterface
public void sendDirect(DataTelegram telegram)
LowLevelCommunicationInterface
sendDirect
in interface LowLevelCommunicationInterface
telegram
- Telegrammpublic void sendDirect(java.util.Collection<DataTelegram> telegrams)
LowLevelCommunicationInterface
sendDirect
in interface LowLevelCommunicationInterface
telegrams
- Telegrammepublic java.lang.String toString()
toString
in class java.lang.Object