CoProcess

An dieser Seite wird momentan noch gearbeitet.

Dieser Artikel soll Hinweise und Best Practices im Umgang mit dem Modul CoProcess.pm und den daraus bereitgestellten Funktionen bieten.

CoProcess.pm enthält eine Sammlung von Routinen um das Ausführen permanent laufender, externen Hilfsprozesse aus FHEM zu vereinfachen. Hierzu gehören:

• Starten und Stoppen
• Überwachen und automatisch am Laufen halten
• Automatisch bei FHEM Start und Stop
• jeder Zeit manuell
• lokales oder entferntes Starten per SSH
• Umleiten von STDOUT und STDERR des Prozesses ins FHEM log oder in ein separates Logfile
• Rotieren und löschen dieses Logfiles nach FHEM Konventionen
• status Readings

Allgemein

Das Modul CoProcess.pm wurde entwickelt, um in die Kontrolle ständig laufender externer Hilfsprozesse zu vereinfachen.

Benutzung

Vorbereitung

• Um die CoProcess Routinen zu verwenden werden diese mit use CoProcess; eingebunden.
• Danach müßen im Device-Hash Information zum externen Prozess hinterlegt werden. Dies geschieht z.b. in der DefineFn:

 $hash->{CoProcess} = {  name => 'alexaFHEM',
                         cmdFn => 'alexa_getCMD',
                      };

Parameter	Optional	Beispiel	Beschreibung
name	nein	'alexaFHEM'	Ein Name für diese CoProcess Klasse. Wird verendet um Defaults für Reading- und Attribut-Namen zu erzeugen.
cmdFn	nein	'alexa_getCMD'	Der Name der Perlfunktion, die die komplette Kommandozeile des zu startenden Prozesses liefert. Wird mit dem Device-Hash als Parameter aufgerufen. Kann undef zurückliefen wenn nichts gestartet werden soll oder kann.

• Das Modul muss eine ReadFn Implementieren in der CoProcess::readFn($hash) aufgerufen wird.

Starten und Stoppen

 CoProcess::start($)
 CoProcess::stop($)
 CoProcess::terminate($)

Lesen und Schreiben

 CoProcess::readFn($)

Muss in der ReadFn des Moduls verwendet werden um

Relevante Internals

Internal	Optional	Beschreibung
logfile	ja	Muster für den Logfile Namen. Bei FHEM wird Siehe commandref/FileLog. Beispiel: ./log/alexa-%Y-%m-%d.log. Bei FHEM wird das Standard FHEM Logfile verwendet. Wenn nicht gesetzt werden die Prozess ausgaben nicht automatisch geloggt.
currentlogfile	-	Wird von CoProcess automatisch auf den Namen des Aktuellen Logfiles gesetzt wenn logfile verwendet wird.
log	-	Filehandle des offenen Logfiles.
PID	-	Enthält die PID des laufenden Prozesses.
FH	-	Enthält den Filehandle um dem Prozess zu kommunizieren. Zum lesen sollte CoProcess::readFn($) verwendet werden.

Relevante Attribute

Im FHEM-Device das CoProcess mit einem Logfile verwendet kann das nrarchive verwendet werden um alte Logfiles zu löschen.

Verwenden von UndefFn, DelayedShutdownFn und ShutdownFn um laufende CoProzesse korrekt zu beenden

In der UndefFn, DelayedShutdownFn und ShutdownFn des Moduls muss sichergestellt werden, dass die laufenden externen Prozesse sauber beendet werden.

Beispiel

sub
alexa_Undefine($$) {
  my ($hash, $name) = @_;
      
  if( $hash->{PID} ) {
    $hash->{undefine} = 1;
    $hash->{undefine} = $hash->{CL} if( $hash->{CL} );
      
    $hash->{reason} = 'delete';
    CoProcess::stop($hash);
      
    return "$name will be deleted after alexa-fhem has stopped or after 5 seconds. whatever comes first.";
  }   
      
  delete $modules{$hash->{TYPE}}{defptr};
      
  return undef;
}

sub
alexa_DelayedShutdownFn($){  
  my ($hash) = @_;
  
  if( $hash->{PID} ) {
    $hash->{shutdown} = 1;
    $hash->{shutdown} = $hash->{CL} if( $hash->{CL} );
  
    $hash->{reason} = 'shutdown';
    CoProcess::stop($hash);
  
    return 1;
  }
  
  return undef;
}  

sub
alexa_Shutdown($){
  my ($hash) = @_;
  
  CoProcess::terminate($hash);
  
  delete $modules{$hash->{TYPE}}{defptr};
  
  return undef;
}  

Anzeige der laufenden CoProzesse

Mit dem FHEM-Befehl coprocessinfo lassen sich die laufenden CoProzesse anzeigen.

Module, die CoProcess.pm verwenden

Folgende Module verwenden aktuell CoProcess.pm um parallel laufende Prozesse zu steuern:

• 30_tradfri.pm
• 39_alexa.pm
• 39_gassistant.pm
• 39_siri.pm