HSL 2.0-Framework Beschreibung des Frameworks

Öffentliche Methoden | Aufstellung aller Elemente
hsl20_4_tcp.hsl20_4_tcp.Client Klassenreferenz

Alle Methoden des TCP-Clients. Mehr ...

## Öffentliche Methoden
def | __init__ (self, framework, context_map)
| Konstruktor. Mehr ...
def | set_address (self, ip, port)
| Setzt die Zieladresse. Mehr ...
def | set_on_connect (self, callback)
| Setzt eine Callback-Methode. Mehr ...
def | set_on_data (self, callback)
| Setzt eine Callback-Methode. Mehr ...
def | set_on_error (self, callback)
| Setzt die Callback-Methode. Mehr ...
def | set_on_close (self, callback)
| Setzt die Callback-Methode. Mehr ...
def | connect (self)
| Versucht, eine Verbindung zur eingerichteten Gegenstelle herzustellen. Mehr ...
def | close (self)
| Schließt die aktuelle Verbindung. Mehr ...
def | send (self, data)
| Sendet Daten zur Gegenstelle. Mehr ...

## Ausführliche Beschreibung

Alle Methoden des TCP-Clients.

Veraltet:
  Diese Klasse sollte nicht mehr eingesetzt werden.

Dient zur Kommunikation mit einer Gegenstelle per TCP/IP.

Zu beachten
  Die Klasse arbeitet asynchron. Keine der angebotenen Methoden blockiert. Klasse ist deprecated

## Beschreibung der Konstruktoren und Destruktoren

## ◆ __init__()

def hsl20_4_tcp.hsl20_4_tcp.Client.__init__ | ( |  | self,
|  |  | framework,
|  |  | context_map
| ) |  |

Konstruktor.

Warnung
  Diese Klasse sollte nicht direkt instanziert werden.

## Dokumentation der Elementfunktionen

## ◆ close()

def hsl20_4_tcp.hsl20_4_tcp.Client.close | ( |  | self | ) |

Schließt die aktuelle Verbindung.

## ◆ connect()

def hsl20_4_tcp.hsl20_4_tcp.Client.connect | ( |  | self | ) |

Versucht, eine Verbindung zur eingerichteten Gegenstelle herzustellen.

Ausnahmebehandlung

  AttributeError | Wird ausgelöst, wenn noch keine IP-Adresse oder kein Port definiert wurde.
  RuntimeError | Wird diese Methode aufgerufen während der Client bereits verbunden wurde, wird eine RuntimeError-Exception ausgelöst.

## ◆ send()

def hsl20_4_tcp.hsl20_4_tcp.Client.send | ( |  | self,
|  |  | data
| ) |  |

Sendet Daten zur Gegenstelle.

Parameter

  data | string Zu versendende Daten

## ◆ set_address()

def hsl20_4_tcp.hsl20_4_tcp.Client.set_address | ( |  | self,
|  |  | ip,
|  |  | port
| ) |  |

Setzt die Zieladresse.

Parameter

  ip | string IP-Adresse oder Hostname
  port | int IP-Port

Ausnahmebehandlung

  RuntimeError | Wird diese Methode aufgerufen während der Client bereits verbunden wurde, wird eine RuntimeError-Exception ausgelöst.

## ◆ set_on_close()

def hsl20_4_tcp.hsl20_4_tcp.Client.set_on_close | ( |  | self,
|  |  | callback
| ) |  |

Setzt die Callback-Methode.

Die Methode wird aufgerufen, sobald die Verbindung (von der Gegenstelle) geschlossen wurde.

Dem Callback werden keine Parameter übergeben.

Parameter

  callback | function Callback-Methode

## ◆ set_on_connect()

def hsl20_4_tcp.hsl20_4_tcp.Client.set_on_connect | ( |  | self,
|  |  | callback
| ) |  |

Setzt eine Callback-Methode.

Die Methode wird aufgerufen, sobald eine Verbindung zur Gegenstelle hergestellt wurde.

Dem Callback werden keine Parameter übergeben.

Parameter

  callback | function Callback-Methode

## ◆ set_on_data()

def hsl20_4_tcp.hsl20_4_tcp.Client.set_on_data | ( |  | self,
|  |  | callback
| ) |  |

Setzt eine Callback-Methode.

Die Methode wird aufgerufen, sobald ein TCP/IP-Telegramm empfangen wurde.

Parameter

  callback | function Callback-Methode data string Daten

## ◆ set_on_error()

def hsl20_4_tcp.hsl20_4_tcp.Client.set_on_error | ( |  | self,
|  |  | callback
| ) |  |

Setzt die Callback-Methode.

Die Methode wird aufgerufen, wenn in der Kommunikation ein Fehler aufgetreten ist.

Parameter für Callback:

- exception Exception
  Das Exception-Object

Parameter

  callback | function Callback-Methode

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

- hsl20_4_tcp.py