La DLL GsAgentDll (ou la classe Java correspondante com.hardis.gts.services.GsAgentDll) permet à un programme de type agent d'interroger ou de modifier le contexte d'exécution de l'agent, et notamment de positionner l'état d'exécution ou le texte du statut associé à l'agent.
Les fonctions permettant de modifier l'état de l'agent (GSASetXXX) doivent impérativement être appelées en partie cliente.
La DLL fournit les fonctions suivantes :
GSAGetId
Cette fonction retourne l'identifiant de l'agent.
Appel possible en partie client ou serveur.
| Nom paramètre | Type | Sens | Description |
Id | NUM_BIN_4 | O | Identifiant GTS de l'agent.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -1 contexte invalide 0 succès
|
GSAGetPid
Cette fonction retourne l'identifiant du processus de l'agent (GSAGENT.EXE - processus client). Cette information n'est valable que sur la machine qui exécute la partie cliente du gestionnaire de travaux.
Appel possible en partie client ou serveur.
Nom paramètre | Type | Sens | Description |
PID | NUM_BIN_4 | O | Identifiant du processus GSAGENT.EXE.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -1 contexte invalide 0 succès |
GSAGetName
Cette fonction retourne le nom externe de l'agent.
Appel possible en partie client ou serveur.
Nom paramètre | Type | Sens | Description |
Name | ALPHA(50) | O | Nom de l'agent.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -1 contexte invalide 0 succès
|
GSAGetGtsName
Cette fonction retourne le nom du GTS exécutant l'agent.
Appel possible en partie client ou serveur.
Nom paramètre | Type | Sens | Description |
Name | ALPHA(250) | O | Nom du GTS exécutant l'agent.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -1 contexte invalide 0 succès
|
GSAGetState
Cette fonction permet de récupérer l'état courant de l'agent. Elle permet notamment de tester si l'arrêt de l'agent a été demandé (état du travail à 'S').
Appel possible en partie client ou serveur connecté à la base du GTS.
Nom paramètre | Type | Sens | Description |
State | ALPHA(1) | O | Etat de l'agent : 'R' agent en cours d'exécution 'S' arrêt demandé
|
CodeRetour | NUM_BIN_4 | O | Code retour : -3 erreur SQL -1 contexte invalide 0 succès |
GSASetState
Cette fonction positionne l'état d'exécution de l'agent, elle doit être appelé en fin de processus pour signifier une terminaison normale, en erreur ou avec avertissements.
Appel possible en partie client uniquement.
Nom paramètre | Type | Sens | Description |
State | ALPHA(1) | I | Nouvel état de l'agent : ' ' agent terminé normalement 'E' agent terminé en erreur 'W' agent terminé avec avertissement
|
CodeRetour | NUM_BIN_4 | O | Code retour : -4 erreur de communication -2 paramètre invalide -1 contexte invalide 0 succès
|
GSAGetStatusText
Cette fonction permet de consulter le texte d'état associé à l'agent.
Appel possible en partie client ou serveur connecté à la base du GTS.
Nom paramètre | Type | Sens | Description |
StatusText | ALPHA(250) | O | Texte d'état de l'agent.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -3 erreur SQL -1 contexte invalide 0 succès
|
GSASetStatusText
Cette fonction permet de fixer le texte d'état associé à l'agent.
Appel possible en partie client uniquement.
Nom paramètre | Type | Sens | Description |
StatusText | ALPHA(250) | I | Texte d'état de l'agent.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -4 erreur de communication -1 contexte invalide 0 succès
|
GSATimedWait
Cette fonction fournit une attente temporisée (sleep) interrompue en cas de changement d'état de l'agent.
Appel possible en partie client uniquement.
Nom paramètre | Type | Sens | Description |
WaitTime | NUM_BIN_4 | I | Temps d'attente en secondes.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -1 contexte invalide 1 temps d'attente écoulé 2 attente interrompue (demande d'arrêt de l'agent)
|
GSATimeToDeath
Cette fonction renvoie le temps d'attente avant arrêt de l'agent dans le cas d'une demande d'arrêt temporisée de l'agent.
Appel possible en partie client uniquement
Nom paramètre | Type | Sens | Description |
TimeToDeath | NUM_BIN_4 | O | Temps d'attente en secondes avant suicide ou -1.
|
CodeRetour | NUM_BIN_4 | O | Code retour : -1 contexte invalide 0 succès
|
