RECEIVE_IMMEDIATE

Le verbe RECEIVE_IMMEDIATE reçoit toutes les données actuellement disponibles à partir du programme de transaction partenaire (TP). Si aucune donnée n’est disponible, le TP local n’attend pas. Pour éviter de bloquer la conversation, le système d’exploitation Microsoft Windows peut émettre des RECEIVE_AND_WAIT conjointement avec WinAsyncAPPC.

La structure suivante décrit le bloc de contrôle de verbe utilisé par le verbe RECEIVE_IMMEDIATE .

Syntaxe

  
struct receive_immediate {  
    unsigned short      opcode;  
    unsigned char       opext;  
    unsigned char       reserv2;  
    unsigned short      primary_rc;  
    unsigned long       secondary_rc;  
    unsigned char       tp_id[8];  
    unsigned long       conv_id;  
    unsigned short      what_rcvd;  
    unsigned char       rtn_status;  
    unsigned char       fill;  
    unsigned char       rts_rcvd;  
    unsigned char       reserv4;  
    unsigned short      max_len;  
    unsigned short      dlen;  
    unsigned char FAR * dptr;  
    unsigned char       reserv5[5];  
};   

Membres

opcode
Paramètre fourni. Spécifie le code d’opération de verbe, AP_B_RECEIVE_IMMEDIATE.

opext
Paramètre fourni. Spécifie l’extension d’opération de verbe, AP_BASIC_CONVERSATION.

reserv2
Champ réservé.

primary_rc
Paramètre retourné. Spécifie le code de retour principal défini par APPC à l’achèvement du verbe. Les codes de retour valides dépendent du verbe APPC émis. Pour connaître les codes d’erreur valides de ce verbe, consultez Codes de retour.

secondary_rc
Paramètre retourné. Spécifie le code de retour secondaire défini par APPC à l’achèvement du verbe. Les codes de retour valides dépendent du verbe APPC émis. Pour connaître les codes d’erreur valides de ce verbe, consultez Codes de retour.

tp_id
Paramètre fourni. Identifie le TP local. La valeur de ce paramètre est retournée par TP_STARTED dans le tp d’appel ou par RECEIVE_ALLOCATE dans le tp appelé.

conv_id
Paramètre fourni. Fournit l’identificateur de conversation. La valeur de ce paramètre est retournée par ALLOCATE dans le tp d’appel ou par RECEIVE_ALLOCATE dans le tp appelé.

what_rcvd
Paramètre retourné. Contient les informations reçues avec les données entrantes. Les valeurs possibles sont répertoriées à la suite de la section Membres.

rtn_status
Paramètre fourni. Indique si les indicateurs de données et de status de conversation doivent être retournés dans un appel d’API.

Utilisez AP_NO pour spécifier que les indicateurs doivent être retournés individuellement sur des appels distincts du verbe.

Utilisez AP_YES pour spécifier que les indicateurs doivent être retournés ensemble, à condition que les deux soient disponibles. Les deux peuvent être retournés dans les cas suivants :

• La mémoire tampon de réception est suffisamment grande pour contenir toutes les données qui précèdent l’indicateur status.

• Le paramètre fill spécifie BUFFER ou LL, et les données sont le dernier enregistrement logique avant l’indicateur de status.

  Remplir
  Paramètre fourni. Spécifie la façon dont le TP local reçoit les données. Il est utilisé uniquement pour RECEIVE_IMMEDIATE.

  Utilisez AP_BUFFER pour indiquer que le tp local reçoit des données jusqu’à ce que le nombre d’octets spécifié par max_len soit atteint ou jusqu’à la fin des données. Les données sont reçues sans tenir compte du format d’enregistrement logique.

  Utilisez AP_LL pour indiquer que les données sont reçues au format d’enregistrement logique. Les données reçues peuvent être un enregistrement logique complet, une partie d’octets max_len d’un enregistrement logique ou la fin d’un enregistrement logique.

  rts_rcvd
  Paramètre retourné. Contient l’indicateur de demande d’envoi. Les valeurs possibles sont les suivantes :

• AP_YES indique que le tp partenaire a émis REQUEST_TO_SEND, qui demande au TP local de modifier la conversation à l’état RECEIVE.

• AP_NO indique que le tp partenaire n’a pas émis de REQUEST_TO_SEND.

  max_len
  Paramètre fourni. Indique le nombre maximal d’octets de données que le TP local peut recevoir. La plage est comprise entre 0 et 65535.

  Pour le système d’exploitation Windows, cette valeur ne doit pas dépasser la longueur de la mémoire tampon pour contenir les données reçues.

  En émettant RECEIVE_IMMEDIATE avec max_len défini sur zéro, le TP local peut déterminer si le tp partenaire a des données à envoyer, demande confirmation ou a modifié l’état de la conversation.

  dlen
  Paramètre retourné. Fournit le nombre d’octets de données reçus. Les données sont stockées dans une mémoire tampon spécifiée par dptr. Une longueur de zéro indique qu’aucune donnée n’a été reçue.

  Dpt
  Paramètre fourni. Adresse de la mémoire tampon pour contenir les données reçues par le tp local.

  Pour le système d’exploitation Windows, la mémoire tampon de données peut résider dans une zone de données statique ou dans une zone allouée globalement. La mémoire tampon de données doit tenir entièrement dans cette zone.

  Valeurs retournées par le paramètre what_rcvd

• AP_CONFIRM_DEALLOCATE indique que le tp partenaire a émis DEALLOCATE avec dealloc_type défini sur AP_SYNC_LEVEL, et que le niveau de synchronisation de la conversation, établi par ALLOCATE, est AP_CONFIRM_SYNC_LEVEL. Lors de la réception de cette valeur, le TP local émet normalement CONFIRM.

• AP_CONFIRM_SEND indique que le tp partenaire a émis PREPARE_TO_RECEIVE avec ptr_type défini sur AP_SYNC_LEVEL, et que le niveau de synchronisation de la conversation, établi par ALLOCATE, est AP_CONFIRM_SYNC_LEVEL. Lors de la réception de cette valeur, le tp local émet normalement CONFIRM et commence à envoyer des données.

• AP_CONFIRM_WHAT_RECEIVED indique que le tp partenaire a émis CONFIRM. Lors de la réception de cette valeur, le TP local émet normalement CONFIRM.

• AP_DATA est retourné pour les conversations de base par RECEIVE_IMMEDIATE si le remplissage est défini sur AP_BUFFER. Le TP local a reçu des données jusqu’à ce que max_len ou la fin des données ait été atteinte. Pour plus d’informations, consultez « RECEIVE_IMMEDIATE fin des données » à la fin de cette rubrique.

• AP_DATA_COMPLETE indique, pour RECEIVE_IMMEDIATE avec remplissage défini sur AP_LL dans les conversations de base, que le tp local a reçu un enregistrement logique complet ou la fin d’un enregistrement logique.

  Lors de la réception de cette valeur, le tp local réédite normalement RECEIVE_IMMEDIATE ou émet un autre verbe de réception. Si le tp partenaire a envoyé plus de données, le TP local commence à recevoir une nouvelle unité de données.

  Sinon, le tp local examine status informations si primary_rc contient AP_OK et what_rcvd contient l’une de ces valeurs :

  AP_SEND

  AP_CONFIRM_SEND

  AP_CONFIRM_DEALLOCATE

  AP_CONFIRM_WHAT_RECEIVED

  Consultez la description de la valeur dans Codes de retour dans cette rubrique pour connaître l’action suivante que le TP local effectue normalement.

  Si primary_rc contient AP_DEALLOC_NORMAL, la conversation a été désallouée en réponse à DEALLOCATE émis par le tp partenaire.

• AP_DATA_INCOMPLETE indique pour RECEIVE_IMMEDIATE dans les conversations mappées que le tp local a reçu un enregistrement de données incomplet. Le paramètre max_len a spécifié une valeur inférieure à la longueur de l’enregistrement de données (ou inférieure au reste de l’enregistrement de données si ce n’est pas le premier verbe de réception à lire l’enregistrement).

  Pour RECEIVE_IMMEDIATE avec remplissage défini sur AP_LL dans les conversations de base, cette valeur indique que le tp local a reçu un enregistrement logique incomplet.

  Lors de la réception de cette valeur, le tp local réédite normalement RECEIVE_IMMEDIATE (ou émet un autre verbe de réception) pour recevoir la partie suivante de l’enregistrement.

• AP_NONE indique que le TP n’a pas reçu de données ou d’indicateurs de status de conversation.

• AP_SEND indique que, pour le tp partenaire, la conversation est entrée dans l’état RECEIVE. Pour le tp local, la conversation est maintenant à l’état SEND. Lors de la réception de cette valeur, le tp local utilise normalement SEND_DATApour commencer à envoyer des données.

Codes de retour

AP_OK
Code de retour principal ; indique que le verbe s’est exécuté correctement.

Lorsque rtn_status est AP_YES, le code de retour précédent ou l’un des codes de retour suivants peut être retourné.

AP_DATA_COMPLETE_SEND
Code de retour principal ; il s’agit d’une combinaison de AP_DATA_COMPLETE et de AP_SEND.

AP_DATA_COMPLETE_CONFIRM_SEND
Code de retour principal ; il s’agit d’une combinaison de AP_DATA_COMPLETE et de AP_CONFIRM_SEND.

AP_DATA_COMPLETE_CONFIRM
Code de retour principal ; il s’agit d’une combinaison de AP_DATA_COMPLETE et de AP_CONFIRM_WHAT_RECEIVED.

AP_DATA_COMPLETE_CONFIRM_DEALL
Code de retour principal ; il s’agit d’une combinaison de AP_DATA_COMPLETE et de AP_CONFIRM_DEALLOCATE.

AP_DATA_SEND
Code de retour principal ; il s’agit d’une combinaison de AP_DATA et de AP_SEND.

AP_DATA_CONFIRM_SEND
Code de retour principal ; il s’agit d’une combinaison de AP_DATA et de AP_CONFIRM_SEND.

AP_DATA_CONFIRM
Code de retour principal ; il s’agit d’une combinaison de AP_DATA et de AP_CONFIRM_WHAT_RECEIVED.

AP_DATA_CONFIRM_DEALLOCATE
Code de retour principal ; il s’agit d’une combinaison de AP_DATA et de AP_CONFIRM_DEALLOCATE.

AP_UNSUCCESSFUL
Code de retour principal ; aucune donnée n’est immédiatement disponible auprès du tp partenaire.

AP_DEALLOC_NORMAL
Code de retour principal ; le TP partenaire a libéré la conversation sans demander de confirmation. Le tp partenaire a émis DEALLOCATE avec dealloc_type défini sur l’un des éléments suivants :

• AP_FLUSH

• AP_SYNC_LEVEL avec le niveau de synchronisation de la conversation spécifié comme AP_NONE

  Si rtn_status est AP_YES, examinez également what_rcvd .

  AP_PARAMETER_CHECK
  Code de retour principal ; le verbe n’a pas été exécuté en raison d’une erreur de paramètre.

  AP_BAD_CONV_ID

  Code de retour secondaire ; la valeur de conv_id ne correspond pas à un identificateur de conversation attribué par APPC.

  AP_BAD_TP_ID

  Code de retour secondaire ; la valeur de tp_id ne correspond pas à un identificateur TP attribué par APPC.

  AP_BAD_RETURN_STATUS_WITH_DATA

  Code de retour secondaire ; la valeur rtn_status spécifiée n’a pas été reconnue par APPC.

  AP_INVALID_DATA_SEGMENT

  Code de retour secondaire ; la longueur spécifiée pour la mémoire tampon de données était supérieure au segment alloué pour contenir la mémoire tampon.

  AP_RCV_IMMD_BAD_FILL

  Code de retour secondaire pour une conversation de base ; le paramètre fill a été défini sur une valeur non valide.

  AP_STATE_CHECK
  Code de retour principal ; le verbe n’a pas été exécuté, car il a été émis dans un état non valide.

  AP_RCV_IMMD_BAD_STATE

  Code de retour secondaire ; la conversation n’était pas à l’état RECEIVE.

  AP_ALLOCATION_ERROR

  Code de retour secondaire ; APPC n’a pas pu allouer une conversation. L’état de la conversation est défini sur RESET.

  Ce code peut être retourné par le biais d’un verbe émis après ALLOCATE.

  AP_ALLOCATION_FAILURE_NO_RETRY

  Code de retour secondaire ; la conversation ne peut pas être allouée en raison d’une condition permanente, telle qu’une erreur de configuration ou une erreur de protocole de session. Pour déterminer l’erreur, l’administrateur système doit examiner le fichier journal des erreurs. Ne réessayez pas l’allocation tant que l’erreur n’a pas été corrigée.

  AP_ALLOCATION_FAILURE_RETRY

  Code de retour secondaire ; La conversation n’a pas pu être allouée en raison d’une condition temporaire, telle qu’un échec de liaison. La raison de l’échec est consignée dans le journal des erreurs système. Réessayez l’allocation.

  AP_CONVERSATION_TYPE_MISMATCH

  Code de retour secondaire ; l’unité logique partenaire (LU) ou TP ne prend pas en charge le type de conversation (de base ou mappé) spécifié dans la demande d’allocation.

  AP_PIP_NOT_ALLOWED

  Code de retour secondaire ; les données PIP spécifiées par la demande d’allocation, mais soit le TP partenaire n’a pas besoin de ces données, soit l’unité logique du partenaire ne les prend pas en charge.

  AP_PIP_NOT_SPECIFIED_CORRECTLY

  Code de retour secondaire ; le TP partenaire nécessite des données PIP, mais la demande d’allocation n’a spécifié aucune donnée PIP ou un nombre incorrect de paramètres.

  AP_SECURITY_NOT_VALID

  Code de retour secondaire ; l’identificateur utilisateur ou le mot de passe spécifiés dans la demande d’allocation n’a pas été accepté par l’unité logique partenaire.

  AP_SYNC_LEVEL_NOT_SUPPORTED

  Code de retour secondaire ; le TP partenaire ne prend pas en charge la sync_level (AP_NONE ou AP_CONFIRM_SYNC_LEVEL) spécifiée dans la demande d’allocation, ou le sync_level n’a pas été reconnu.

  AP_TP_NAME_NOT_RECOGNIZED

  Code de retour secondaire ; la lu partenaire ne reconnaît pas le nom TP spécifié dans la demande d’allocation.

  AP_TRANS_PGM_NOT_AVAIL_NO_RETRY

  Code de retour secondaire ; la lu distante a rejeté la demande d’allocation, car elle n’a pas pu démarrer le TP partenaire demandé. La condition est permanente. La raison de l’erreur peut être consignée sur le nœud distant. Ne réessayez pas l’allocation tant que l’erreur n’a pas été corrigée.

  AP_TRANS_PGM_NOT_AVAIL_RETRY

  Code de retour secondaire ; la lu distante a rejeté la demande d’allocation, car elle n’a pas pu démarrer le TP partenaire demandé. La situation peut être temporaire, par exemple un délai d’attente. La raison de l’erreur peut être consignée sur le nœud distant. Réessayez l’allocation.

  AP_COMM_SUBSYSTEM_ABENDED
  Code de retour principal ; indique l’une des situations suivantes :

• Le nœud utilisé par cette conversation a rencontré un abandon (ABEND).

• La connexion a été interrompue entre le programme transactionnel et le nœud PU 2.1 (erreur LAN).

• Le processus SnaBase qui se déroule sur l’ordinateur du programme transactionnel a rencontré un abandon (ABEND).

  L’administrateur système doit examiner le journal des erreurs pour déterminer la raison de l’abandon.

  AP_COMM_SUBSYSTEM_NOT_LOADED
  Code de retour principal ; Un composant requis n’a pas pu être chargé ou s’est terminé lors du traitement du verbe. Par conséquent, la communication n’a pas pu être établie. Contactez l’administrateur système pour mettre en place une action corrective.

  Lorsque ce code de retour est utilisé avec ALLOCATE, il peut indiquer qu’aucun système de communication n’a pu être trouvé pour prendre en charge la lu locale. (Par exemple, l’alias de lu local spécifié avec TP_STARTED est incorrect ou n’a pas été configuré.) Notez que si lu_alias ou mode_name contient moins de huit caractères, vous devez vous assurer que ces champs sont remplis d’espaces à droite. Cette erreur est retournée si ces paramètres ne sont pas remplis d’espaces, car aucun nœud disponible ne peut satisfaire la requête ALLOCATE .

  Lorsque ALLOCATE produit ce code de retour pour un système client Host Integration Server configuré avec plusieurs nœuds, il existe deux codes de retour secondaires comme suit :

  0xF0000001

  Code de retour secondaire ; aucun nœud n’a été démarré.

  0xF0000002

  Code de retour secondaire ; au moins un nœud a été démarré, mais l’unité logique locale (lorsque TP_STARTED est émis) n’est pas configurée sur les nœuds actifs. Le problème peut être l’un des suivants :

• Le nœud avec l’unité logique locale n’est pas démarré.

• La lu locale n’est pas configurée.

  AP_CONV_FAILURE_NO_RETRY
  Code de retour principal ; la conversation a été arrêtée en raison d’une condition permanente, telle qu’une erreur de protocole de session. L’administrateur système doit examiner le journal des erreurs système pour déterminer la cause de l’erreur. Ne réessayez pas la conversation tant que l’erreur n’a pas été corrigée.

  AP_CONV_FAILURE_RETRY
  Code de retour principal ; la conversation a été arrêtée en raison d’une erreur temporaire. Redémarrez le tp pour voir si le problème se produit à nouveau. Si c’est le cas, l’administrateur système doit examiner le journal des erreurs pour déterminer la cause de l’erreur.

  AP_CONVERSATION_TYPE_MIXED
  Code de retour principal ; le TP a émis des verbes de conversation de base et mappés. Un seul type peut être émis dans une même conversation.

  AP_INVALID_VERB_SEGMENT
  Code de retour principal ; indique que le bloc de contrôle de verbe s’étend au-delà de la fin du segment de données.

  AP_PROG_ERROR_NO_TRUNC
  Code de retour principal ; le tp partenaire a émis SEND_ERROR avec err_type défini sur AP_PROG alors que la conversation était à l’état SEND. Les données n’ont pas été tronquées.

  AP_PROG_ERROR_PURGING
  Code de retour principal ; alors qu’à l’état RECEIVE, PENDING, PENDING_POST, CONFIRM, CONFIRM_SEND ou CONFIRM_DEALLOCATE, le partenaire TP a émis SEND_ERROR avec err_type défini sur AP_PROG. Les données envoyées mais pas encore reçues sont vidées.

  AP_PROG_ERROR_TRUNC
  Code de retour principal ; dans l’état SEND, après l’envoi d’un enregistrement logique incomplet, le tp partenaire a émis SEND_ERROR avec err_type défini sur AP_PROG. Le TP local peut avoir reçu la première partie de l’enregistrement logique par le biais d’un verbe de réception.

  AP_STACK_TOO_SMALL
  Code de retour principal ; indique que la taille de la pile de l’application est trop petite pour exécuter le verbe. Augmentez la taille de pile de votre application.

  AP_CONV_BUSY
  Code de retour principal ; il ne peut y avoir qu’un seul verbe de conversation en suspens à la fois sur n’importe quelle conversation. Cela peut se produire si le tp local a plusieurs threads et que plusieurs threads émettent des appels APPC à l’aide du même conv_id.

  AP_UNEXPECTED_DOS_ERROR
  Code de retour principal ; indique que le système d’exploitation a retourné une erreur à APPC lors du traitement d’un appel APPC à partir du programme transactionnel local. Le code de retour du système d’exploitation a été retourné via secondary_rc. Il apparaît dans l’ordre Intel avec permutation d’octets. Si le problème persiste, consultez l’administrateur système.

  AP_DEALLOC_ABEND_PROG
  Code de retour principal ; la conversation a été libérée pour l’une des raisons suivantes :

• Le tp partenaire a émis DEALLOCATE avec dealloc_type défini sur AP_ABEND_PROG.

• Le TP partenaire a rencontré un ABEND, ce qui a entraîné l’envoi d’une requête DEALLOCATE par l’unité logique du partenaire.

  AP_DEALLOC_ABEND_SVC
  Code de retour principal ; la conversation a été libérée, car le tp partenaire a émis DEALLOCATE avec dealloc_type défini sur AP_ABEND_SVC.

  AP_DEALLOC_ABEND_TIMER
  Code de retour principal ; la conversation a été libérée, car le tp partenaire a émis DEALLOCATE avec dealloc_type défini sur AP_ABEND_TIMER.

  AP_SVC_ERROR_NO_TRUNC
  Code de retour principal ; dans l’état SEND, le TP partenaire (ou LU partenaire) a émis SEND_ERROR avec err_type défini sur AP_SVC. Les données n’ont pas été tronquées.

  AP_SVC_ERROR_PURGING
  Code de retour principal ; le TP partenaire (ou lu partenaire) émis SEND_ERROR avec err_type défini sur AP_SVC dans l’état RECEIVE, PENDING_POST, CONFIRM, CONFIRM_SEND ou CONFIRM_DEALLOCATE. Les données envoyées au programme transactionnel de partenaire ont peut-être été vidées.

  AP_SVC_ERROR_TRUNC
  Code de retour principal ; Dans l’état SEND, après l’envoi d’un enregistrement logique incomplet, le TP partenaire (ou lu partenaire) a émis SEND_ERROR. Le TP local a peut-être reçu la première partie de l’enregistrement logique.

Remarques

Le TP local reçoit des données par le biais du processus suivant :

1. Le tp local émet un verbe de réception jusqu’à ce qu’il finissent de recevoir une unité complète de données. Les données reçues peuvent être :

   • Un enregistrement logique.

   • Mémoire tampon des données reçues indépendamment de leur format d’enregistrement logique.

     Le tp local peut avoir besoin d’émettre le verbe de réception plusieurs fois pour recevoir une unité complète de données. Une fois qu’une unité complète de données a été reçue, le TP local peut la manipuler.

     Les verbes de réception sont RECEIVE_AND_POST, RECEIVE_AND_WAIT et RECEIVE_IMMEDIATE.

2. Le TP local émet à nouveau le verbe de réception. Cela a l’un des effets suivants :

   • Si le tp partenaire a envoyé plus de données, le TP local commence à recevoir une nouvelle unité de données.

   • Si le tp partenaire a terminé d’envoyer des données ou attend une confirmation, status informations (disponibles via what_rcvd) indique l’action suivante que le TP local effectue normalement.

   La conversation doit être à l’état RECEIVE lorsque le tp émet ce verbe.

   Le nouvel état est déterminé par primary_rc. Si primary_rc est AP_OK, le nouvel état est déterminé par what_rcvd.

   Le tableau suivant détaille les changements d’état lorsque le primary_rc est AP_OK.

Le tableau suivant détaille les changements d’état lorsque le primary_rc n’est pas AP_OK.

RECEVOIR IMMÉDIATEMENT les données

Dans les conversations de base, si le TP local rencontre des problèmes RECEIVE_IMMEDIATE et définit le remplissage sur AP_BUFFER, la réception des données prend fin lorsque max_len ou la fin des données est atteinte. La fin des données est indiquée par :

• Paramètre primary_rc avec une valeur autre que AP_OK (par exemple, AP_DEALLOC_NORMAL).

• Paramètre what_rcvd avec l’une des valeurs suivantes :

  AP_SEND

  AP_CONFIRM_SEND

  AP_CONFIRM_DEALLOCATE

  AP_CONFIRM_WHAT_RECEIVED

  AP_DATA_CONFIRM_SEND

  AP_DATA_CONFIRM_DEALLOCATE

  AP_DATA_CONFIRM

  Pour déterminer si la fin des données a été atteinte, le TP local réédite RECEIVE_IMMEDIATE. Si le nouveau paramètre primary_rc contient AP_OK et what_rcvd contient AP_DATA, la fin des données n’a pas été atteinte. Si, toutefois, la fin des données a été atteinte, primary_rc ou what_rcvd indique la cause de la fin des données.