Changes between Version 1 and Version 2 of SoftWare/SignalCheckpoint/API


Ignore:
Timestamp:
Oct 11, 2012, 2:14:48 PM (12 years ago)
Author:
g7moreau
Comment:

Explication des appels de fonction

Legend:

Unmodified
Added
Removed
Modified
  • SoftWare/SignalCheckpoint/API

    v1 v2  
    11= SoftWare/SignalCheckpoint / API - Application Programming Interface =
     2
     3L'API du module {{{SignalCheckpoint}}} est simple, réduite au maximum.
     4C'est voulu.
     5L'objectif est d'avoir une bibliothèque facile à mettre en oeuvre dans le cadre du calcul intensif.
     6
     7== Constantes ==
    28
    39Le module Fortran '''{{{Signal_Checkpoint}}}''' exporte un certain nombre de signaux.
     
    1420}}}
    1521
     22== Appels de fonction et de procédure ==
     23
    1624Quelques procédures et fonctions permettent la gestion de ces signaux
    1725
     
    2230   logical,intent(in),optional :: EXIT
    2331}}}
     32 Appel à placer en début de programme afin d'indiquer le ou les signaux à prendre en compte.
     33 Le paramètre {{{EXIT}}} permet de lever un drapeau supplémentaire si le signal est reçu.
     34 Ce drapeau est utile si on souhaite que son programme puisse réagir de manière différente à deux signaux.
    2435
    2536 * '''{{{signal_checkpoint_is_received}}}'''
     
    2839   logical :: IS_RECEIVED
    2940}}}
     41 Fonction qui retourne positivement si un signal a été reçu.
     42 Il est donc temps de penser à finir proprement...
    3043
    3144 * '''{{{signal_checkpoint_ask_for_exit_code}}}'''
     
    3447   logical :: EXIT
    3548}}}
     49 Drapeau permettant de savoir si le signal marqué {{{EXIT}}} a été reçu.
     50 Cela permet de quitter le programme avec un code d'erreur par exemple et non avec la valeur classique 0.
     51 En effet, ce code de retour peut être utilisé par le scheduleur
     52 ou le script de lancement batch
     53 pour savoir si le code doit être re-soumis ou non.
    3654
    3755 * '''{{{signal_checkpoint_received_times}}}'''
     
    4058   integer :: RECEIVED_TIMES
    4159}}}
     60 Fonction qui retourne le nombre de signaux reçu.
     61 Cette fonction ne sers à rien dans un code de calcul
     62 car ce nombre n'a pas de signification autre que {{{== 0}}} ou {{{> 0}}},
     63 signification déjà donné par l'appel {{{signal_checkpoint_is_received}}}.
     64 Elle est juste utile en phrase de test afin de valider que l'on reçois bien les signaux !