Différences

Ci-dessous, les différences entre deux révisions de la page.

--- refmodule [2026/08/04 09:05] – [pdf] root
+++ refmodule [2026/08/04 12:03] (Version actuelle) – [shm] root
@@ Ligne 116: / Ligne 116: @@
   * ''addImage(pdfParameterSet)''  : ajoute à la page courante une image déjà chargée au préalable, selon les informations décrites dans la hashtable ''pdfParameterSet''  qui doit contenir les champs suivants :
       * ''.X'', ''.Y''  : coordonnées x,y du coin haut/gauche de l'image dans la page
-      * ''.Image''  : numéro de l'image
+      * ''.ImageIndex''  : numéro de l'image
   * ''loadImage(image, format)''  : charge dans le module, pour un usage ultérieur, l'image dont le contenu est passé dans la chaîne ''image''. La première image chargée porte le numéro 1, etc. Formats supportés, chaîne ''format''  : //BMP//  (32bpp) et //GIF//.
-  * ''delImage(image)''  : supprime l'image numéro ''image''  du module ; elle ne pourra plus être utilisée par la suite (NOTA pbm de numéro avec suppression)
+  * ''delImage(imageIndex)''  : supprime l'image numéro ''imageIndex''  du module ; elle ne pourra plus être utilisée par la suite (NOTA pbm de numéro avec suppression)
-  * ''listing(pdfParameterSet, textContentThenPdfContent)''  : créé un document Pdf, de type //listing//, avec les données textuelle de ''textContentThenPdfContent''  et renvoie le contenu du Pdf généré dans ''textContentThenPdfContent''. Les éléments permettant de créer le listing sont donnés par la hashtable ''pdfParameterSet''  qui doit contenir les champs suivants :
+  * ''listing(pdfParameterSet, textThenPdfContent)''  : créé un document Pdf, de type //listing//, avec les données textuelle de ''textThenPdfContent''  et renvoie le contenu du Pdf généré dans ''textThenPdfContent''. Les éléments permettant de créer le listing sont donnés par la hashtable ''pdfParameterSet''  qui doit contenir les champs suivants :
       * ''.Title''  : titre du listing (texte)
       * ''.Format''  : nombre donnant le format de la page à utiliser : A4P A4L (1 2)
@@ Ligne 150: / Ligne 150: @@
 ==== shm ====
-NOTA : module à finir, revoir doc (newprocessshmreader/writer) Module gérant la communication inter-processus, basée sur des messages textes. Chaque processus possède une //queue// qui permet de recevoir les messages émis par les autres processus.
+//NOTA// : module à finir, revoir doc (newprocessshmreader/writer) Module gérant la communication inter-processus, basée sur des messages textes. Chaque processus possède une //queue// qui permet de recevoir les messages émis par les autres processus.
    * ''get(content)''  : renvoi dans ''content''  le prochain message reçu depuis la queue interne du processus en cours. S'il n'y a pas de message à lire, renvoi //vide//.
@@ Ligne 167: / Ligne 167: @@
   * ''get(socket, data, timeout)''  : lit les données venant de l'autre côté de la connexion identifiée par l'id ''socket''. Les données lues sont renvoyées dans la chaîne ''data''. Si aucune donnée d'est disponible au bout du délai ''timeout''  donné, (en secondes), la chaîne ''data''  est renvoyée //vide//.
   * ''set(socket, data)''  : écrit les données de ''data''  sur la connexion identifiée par l'id ''socket''.
+  * ''getHostname(name, ip)''  : renvoi le nom (dans ''name'') et l'addresse ip (dans ''ip'') de l'hôte qui exécute le programme en cours.
-==== ssh ====
+==== wssh ====
 Module basé sur ''lib_ssh'' permettant l'accès sécurisé à un serveur.
-   * ''openSession(host, username, password)''  : ouvre une connexion sécurisée vers le serveur ''host'' <font inherit/inherit;;inherit;;rgb(251, 250, 249)></font> (nom ou adresse IP), en utilisant l'authentification ''username'' /''password''
+   * ''openSession(host, username, password)''  : ouvre une connexion sécurisée vers le serveur ''host''  (nom ou adresse IP), en utilisant l'authentification ''username''  /''password''
   * ''endSession''  : ferme la connexion courante
-  * ''execChannel(command, response, timeout)''  : exécute la commande ''command'' sur le serveur distant, et lit la réponse dans ''response'', en utilisant la paramètre ''timeout''  comme délai de lecture (en seconde).
+  * ''execChannel(command, response, timeout)''  : exécute la commande ''command''  sur le serveur distant, et lit la réponse dans ''response'', en utilisant la paramètre ''timeout''  comme délai de lecture (en seconde).
   * ''openChannel''  : ouvre un //pseudo terminal//  sur le serveur distant.
   * ''closeChannel''  : termine le //pseudo terminal//  distant.
   * ''readChannel(response, timeout)''  : lit la réponse du serveur distant dans ''response'', en utilisant ''timeout''  comme délai de lecture (en seconde).
-  * ''writeChannel(command)''  : exécute la commande ''command'' sur le serveur distant
+  * ''writeChannel(command)''  : exécute la commande ''command''  sur le serveur distant
+  * ''openSftp''  : ouvre un canal de type //transfer//  avec le serveur distant.
+  * ''closeSftp''  : ferme le canal de type //transfert//  mais laisse la connexion au serveur ouverte.
+  * //to be continued…//
 Pour l'exécution de commandes ponctuelles, le worflow typique d'exécution est le suivant :
 <code wlang>
 ;
-invoke ssh&openSession(host, user, pwd)
+invoke wssh&openSession(host, user, pwd)
 ;
 ; do something
 ;
-invoke ssh&execChannel(cmd, res, timeout)
+invoke wssh&execChannel(cmd, res, timeout)
 ;
 ; do another thing
 ;
-invoke ssh&execChannel(cmd, res, timeout)
+invoke wssh&execChannel(cmd, res, timeout)
 ;
 ; terminate
-invoke ssh&endSession
+invoke wssh&endSession
 ;
 </code>
@@ Ligne 204: / Ligne 209: @@
 <code wlang>
 ;
-invoke ssh&openSession(host, user, pwd)
+invoke wssh&openSession(host, user, pwd)
-invoke ssh&openChannel
+invoke wssh&openChannel
 ;
 ; read login information
-invoke ssh&readChannel(res, timeout)
+invoke wssh&readChannel(res, timeout)
 ;
 loop
    ;
-   invoke ssh&writeChannel(cmd)
+   invoke wssh&writeChannel(cmd)
    ;
-   invoke ssh&readChannel(res, timeout)
+   invoke wssh&readChannel(res, timeout)
    ;
 endloop
 ;
 ; terminate
-invoke ssh&endSession
+invoke wssh&endSession
 ;
 </code>
@@ Ligne 234: / Ligne 240: @@
   * ''updateEnv(varName, value)''  : met à jour la variable d'environnement ''varName''  avec la valeur ''value''. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est inconnue de la session en cours.
   * ''deleteEnv(varName)''  : supprime la variable d'environnement nommée ''varName''  de la session courante. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est inconnue
-  * ''getOS(OScode)''  : renvoi un code, dans le paramètre ''OScode'', indiquant le type de l'OS hôte du programme en cours : Windows, Linux…
+  * ''getOS(OScode)''  : renvoi un code, dans le paramètre ''OScode'', indiquant le type de l'OS hôte du programme en cours (de type chaîne) : //Windows//, //Linux//
-  * ''getHostname(name, ip)''  : renvoi le nom (dans ''name'') et l'addresse ip (dans ''ip'') de l'hôte qui exécute le programme en cours
   * ''sendSignal(pid, signalNumber)''  : envoi le signal numéro ''signalNumber''  au processus identifié par son numéro ''pid''. Seuls les 3 signaux SIGTERM, SIGINT, SIGUSR1 sont pris en charge. Les autres sont ignorés. Fonction compatible Unix/Windows mais sous Windows, ce sont des évènements qui sont générés, pas des signaux ; SIGTERM et SIGINT génèrent un évènement ''Global\\wterm<pid>''  et SIGUSR1 génère un évènement ''Global\\wdebug<pid>''
   * ''sleep(duration)''  : endort le process en cours, pour une durée de ''duration''  secondes