Téléchargement des produits


Version anglaise


 

Sens affectés aux paramètres des méthodes :

(E)

Entrée

(S)

Sortie

Liste des codes retour des différentes méthodes :

_NATS_ERR_OK L'exécution de la méthode s'est déroulée correctement.
_NATS_ERR_ERREUR Une erreur inattendue s'est produite.
_NATS_ERR_PARAMETRE_INVALIDE Paramètre invalide.
_NATS_ERR_NON_CONNECTE Non connecté.



Connexion à NATS.

Syntaxe

APPELER_METHODE NomObjet CONNECTER Urls Options CodeRetour

Paramètres

Urls (E)

ALPHA(n)

Liste d'URLs d'accès a NATS, séparées par le caractère ";".

Si le paramètre est vide, on se connecte au serveur local (nats://localhost:4222).

Options (E)

ALPHA(n)

Liste d'options de connexion, sous la forme d'un ensemble de couples clé/valeur, le caractère ":" séparant la clé de la valeur, le caractère ";" séparant les options.

Les options acceptées sont :

clientID ID du client.
user Nom de l'utilisateur, pour une connexion par utilisateur/mot de passe.
password Mot de passe de l'utilisateur.
nkey Clé privée de l'utilisateur, pour une connexion par clé d'utilisateur.
nkey_file Nom d'un fichier contenant la clé privée de l'utilisateur, pour une connexion par clé d'utilisateur.
token Jeton JWT, pour une connexion par jeton utilisateur.
token_file Nom d'un fichier contenant un jeton JWT, pour une connexion par jeton utilisateur.
creds_file Nom d'un fichier contenant les identifiants de connexion NATS (Jeton + NKEY).



CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Déconnexion de NATS. Cette méthode est sans effet si vous n'êtes pas actuellement connecté.

Syntaxe

APPELER_METHODE NomObjet DECONNECTER

Souscription à un sujet NATS.

Syntaxe

APPELER_METHODE NomObjet SOUSCRIRE Sujet NbMaxMessages TypeSouscription Options CodeRetour

Paramètres

Sujet (E)

ALPHA(250)

 Sujet NATS.

NbMaxMessages (E)

NUM_BIN_4

 Nombre maximum de messages à lire. Si NbMaxMessages est > 0, le souscripteur s'arrêtera automatiquement après avoir lu NbMaxMessages messages.

TypeSouscription (E)

NUM_BIN_4

Type de la souscription.

_NATS_CONS_TYPE_SIMPLE Consommateur NATS Core
_NATS_CONS_TYPE_PUSH Consommateur JetStream PUSH
_NATS_CONS_TYPE_PULL Consommateur JetStream PULL

Options (E)

ALPHA(n)

Liste d'options pour les souscripteurs JetStream, sous la forme d'un ensemble de couples clé/valeur, le caractère : séparant la clé de la valeur, le caractère ; séparant les options.

Les options acceptées sont :

name Nom du consommateur.
stream Nom du stream NATS.
durable Nom du durable du consommateur.
bind Lier à un consommateur existant (name doit référencer le nom du consommateur)
messageAlarmTime Temps d'attente entre deux messages ou battements de cœur avant de déclencher une erreur.
ordered Délivrance ordonnée des messages (PUSH uniquement).
deliverSubject Sujet destinataire (PUSH uniquement).
deliverGroup

Groupe de destinataires (PUSH uniquement). Doit correspondre au paramètre queue si les deux sont spécifiés.
pendingMessageLimit Nombre maximum de messages en attente (PUSH uniquement).
pendingByteLimit Taille maximum des messages en attente (PUSH uniquement).
queue Queue à utiliser (PUSH uniquement).
fastBind Liaison rapide. La concordance des paramètres du consommateur n'est pas validée (PULL uniquement).
fetchSize

Taille du batch à traiter (PULL uniquement).
autoAck

Acquittement automatique du message en fin de traitement par onMessage si la méthode ACQUITTER_MESSAGE n'a pas été appelée par le programme.


Valeurs possibles :

ack Acquitte le message.
nak Rejette le message (il sera réémis).
term Termine le message (il ne sera pas réémis).


Ce paramètre est ignoré dans le cas d'un souscripteur NATS Core.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Annule la souscription à un sujet NATS.

Syntaxe

APPELER_METHODE NomObjet ANNULER_SOUSCRIPTION Sujet CodeRetour

Paramètres

Sujet (E)

ALPHA(250)

 Sujet NATS.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Envoyer un message à un sujet NATS.

Syntaxe

APPELER_METHODE NomObjet ENVOYER_MESSAGE Sujet RepondreA Entetes Message CodeRetour

Paramètres

Sujet (E)

ALPHA(250)

 Sujet NATS.

RepondreA (E)

ALPHA(250)

 Sujet devant recevoir une réponse.

Entêtes (E)

ALPHA(n)

Liste d'en-têtes pour le message, sous la forme d'un ensemble de couples clé/valeur, le caractère ":" séparant le nom de l'en-tête de la valeur, le caractère ";" séparant les en-têtes.

Il est possible de fournir plusieurs valeurs pour un en-tête en les séparant par le caractère ",".

Si les caractères "," ou ";" doivent apparaître dans la valeur d'un en-tête, vous devez les remplacer respectivement par les caractères d'échappement suivants : %2c et %3b.

Message(E)

ALPHA(n) ou

IMAGE

Corps du message. Si le corps est une variable alphanumérique, elle est convertie en UTF-8.

CodeRetour (S)

NUM_BIN_4

Code retour de la méthode.

Acquittement du message. Cette méthode peut être appelée uniquement lors du traitement de l'événement MessageRecu.

Syntaxe

APPELER_METHODE NomObjet ACQUITTER_MESSAGE Mode Delai CodeRetour

Paramètres

Mode (E)

NUM_BIN_4

Mode d'acquittement. Valeurs possibles :

_NATS_ACQUITTER Acquitter.
_NATS_REJETER Rejeter (le message sera réémis).
_NATS_TERMINER Terminer (le message ne sera pas réémis).
_NATS_EN_COURS Le message est en cours de traitement.

Mode (E)

NUM_BIN_4

 Sujet NATS.

CodeRetour (S)

BOOL

Code retour de la méthode.

Compte les en-têtes associés à un message. Cette méthode peut être appelée uniquement lors du traitement de l'événement MessageRecu.

Syntaxe

APPELER_METHODE NomObjet COMPTER_ENTETES NombreEntetes

Paramètres

NombreEntetes (S)

NUM_BIN_4

Nombre d'en-têtes associés au message.

Récupère le nom de l'énième en-tête d'un message. Cette méthode peut être appelée uniquement lors du traitement de l'événement MessageRecu.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_NOM_ENTETE NumeroEntete NomEntete

Paramètres

NumeroEntete (E)

NUM_BIN_4

Numéro de l'en-tête.

NomEntete (S)

ALPHA(250)

Nom de l'en-tête.

Compte le nombre de valeurs associées à un en-tête. Cette méthode peut être appelée uniquement lors du traitement de l'événement MessageRecu.

Syntaxe

APPELER_METHODE NomObjet COMPTER_VALEURS_ENTETE NomEntete NombreValeurs

Paramètres

NomEntete (S)

ALPHA(250)

Nom de l'en-tête.

NombreValeurs (S)

NUM_BIN_4

Nombre de valeurs associées a l'en-tête.

Compte le nombre de valeurs associées à un en-tête. Cette méthode peut être appelée uniquement lors du traitement de l'événement MessageRecu.

Syntaxe

APPELER_METHODE NomObjet RECUPERER_VALEUR_ENTETE NomEntete NumeroValeur ValeurEntete

Paramètres

NomEntete (S)

ALPHA(250)

Nom de l'en-tête.

NumeroValeur (S)

NUM_BIN_4

Numéro de la valeur.

ValeurEntete (S)

ALPHA(250)

Valeur de l'énième en-tête.



↑ Haut de page