com.langner.factoryxml.sdk
Interface Connection

public interface Connection

Über dieses Interface haben Sie Zugriff auf einen Dienst, bzw. ein Gerät.
Erzeugen können Sie eine Instanz nur über die Klasse Directory, indem Sie eine der getConnection Funktionen verwenden.

Nested Class Summary

static interface

Connection.Listener Über dieses Interface erhalten Sie Informationen über den Verbindungszustand.

Method Summary

boolean	addListener(Connection.Listener fListener) Fügt einen neuen Listener ein, der bei entsprechenden Ereignissen aufgerufen wird.
boolean	connect() Stellt explizit eine Verbindung zu dem Dienst her.
boolean	disconnect() Trennt die Verbindung zu dem Dienst.
void	dispose() Rufen Sie diese Funktion auf, wenn Sie diese Instanz mit den dazugehörigen Datenpunkten nicht mehr benötigen.
java.lang.String	getAddress() Ermittelt die Adresse des Dienstes.
Transport	getCurrentTransport() Ermittelt die aktuelle Verbindung zu diesem Dienst.
Datapoint	getDatapoint(java.lang.String fAddress) Erzeugt eine neue Instanz der Klasse Datapoint.
java.lang.String[]	getDatapoints() Ermittelt die veröffentlichten Datenpunkte des Dienstes.
java.util.Properties	getProperties() Ermittelt Eigenschaften zu dieser Instanz.
boolean	hasSubscription() Ermittelt, ob eine Benachrichtigung aktiv ist.
boolean	isConnected() Ermittelt den aktuellen Verbindungsstatus.
boolean	removeListener(Connection.Listener fListener) Entfernt den angegebenen Listener.
java.lang.String	subscribeAllCyclic(java.lang.Integer fInterval) Diese Funktion ermöglicht es Ihnen, die Werte für alle Datenpunkte eines Dienstes periodisch zu ermitteln.
java.lang.String	subscribeAllDelta() Diese Funktion ermöglicht es Ihnen, die Werte für alle Datenpunkte eines Dienstes bei jeder Änderung zu ermitteln.
boolean	unsubscribe() Beendet eine aktive Benachrichtigung.

Method Detail

dispose

public void dispose()

Rufen Sie diese Funktion auf, wenn Sie diese Instanz mit den dazugehörigen Datenpunkten nicht mehr benötigen.
Die Verbindung wird abgebaut und die Verknüpfung mit den Datenpunkten wird aufgehoben.
Nach dem Aufruf erhalten Sie, bei den über diese Instanz erzeugten Datenpunkten, keine gültigen Werte mehr.

addListener

public boolean addListener(Connection.Listener fListener)

Fügt einen neuen Listener ein, der bei entsprechenden Ereignissen aufgerufen wird.

Parameters:

fListener - Der hinzuzufügende Listener

Returns:

true wenn der Listener erfolgreich hinzugefügt wurde. Ansonsten false.

removeListener

public boolean removeListener(Connection.Listener fListener)

Entfernt den angegebenen Listener.
Ereignisse werden dann nicht mehr an dieses Instanz gemeldet.

Parameters:

fListener - Der zu entfernende Listener

Returns:

true wenn der Listener erfolgreich entfernt wurde. Ansonsten false.

connect

public boolean connect()

Stellt explizit eine Verbindung zu dem Dienst her.
Da alle Funktionen die Verbindung automatisch bei Bedarf herstellen, muss diese Funktion nicht zwangsweise aufgerufen werden.

Returns:

true wenn die Verbindung hergestellt ist. Ansonsten false.

disconnect

public boolean disconnect()

Trennt die Verbindung zu dem Dienst.

Returns:

true wenn die Verbindung getrennt ist. Ansonsten false.

isConnected

public boolean isConnected()

Ermittelt den aktuellen Verbindungsstatus.

Returns:

true wenn zur Zeit eine Verbindung besteht. Ansonsten false.

getCurrentTransport

public Transport getCurrentTransport()

Ermittelt die aktuelle Verbindung zu diesem Dienst.

Returns:

Liefert die aktuelle Verbindung zu diesem Dienst.

getAddress

public java.lang.String getAddress()

Ermittelt die Adresse des Dienstes.

Returns:

Liefert die Adresse des Dienstes.

getDatapoints

public java.lang.String[] getDatapoints()

Ermittelt die veröffentlichten Datenpunkte des Dienstes.

Returns:

Liefert die Adressierungen der Datenpunkte.

getDatapoint

public Datapoint getDatapoint(java.lang.String fAddress)

Erzeugt eine neue Instanz der Klasse Datapoint.
Über die Datapoint- Klasse erhalten Sie Zugriff auf einen einzelnen Datenpunkt.
Falls die Adresse des Datenpunktes bekannt ist, können Sie diese direkt übergeben.
Ansonsten können Sie die veröffentlichten Datenpunkte über die Funktion getDatapoints() ermitteln.

Parameters:

fAddress - Adressierung des Datenpunktes.

Returns:

Liefert die neue Instanz.

subscribeAllCyclic

public java.lang.String subscribeAllCyclic(java.lang.Integer fInterval)

Diese Funktion ermöglicht es Ihnen, die Werte für alle Datenpunkte eines Dienstes periodisch zu ermitteln.
Die neuen Werte bekommen Sie dann über die angemeldeten Listener signalisiert.
Ist bereits eine Benachrichtigung aktiv, wird diese zuvor beendet.

Parameters:

fInterval - Zeitintervall in Millisekunden.
Bzw. null, wenn der voreingestellte Wert des Dienstes verwendet werden soll.

Returns:

Referenz zu diesem Befehl.

subscribeAllDelta

public java.lang.String subscribeAllDelta()

Diese Funktion ermöglicht es Ihnen, die Werte für alle Datenpunkte eines Dienstes bei jeder Änderung zu ermitteln.
Die neuen Werte bekommen Sie dann über die angemeldeten Listener signalisiert.
Ist bereits eine Benachrichtigung aktiv, wird diese zuvor beendet.

Returns:

Referenz zu diesem Befehl.

hasSubscription

public boolean hasSubscription()

Ermittelt, ob eine Benachrichtigung aktiv ist.

Returns:

true wenn eine Benachrichtigung aktiv ist. Ansonsten false.

unsubscribe

public boolean unsubscribe()

Beendet eine aktive Benachrichtigung.

Returns:

true wenn die Abmeldung erfolgreich war. Ansonsten false.

getProperties

public java.util.Properties getProperties()

Ermittelt Eigenschaften zu dieser Instanz.

Returns:

Liefert die Eigenschaften.