MC_RECEIVE_IMMEDIATE

Le verbe MC_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 problème MC_RECEIVE_AND_WAIT conjointement avec WinAsyncAPPC. La structure suivante décrit le bloc de contrôle de verbe (VCB) utilisé par le verbe MC_RECEIVE_IMMEDIATE .

Syntaxe

  
struct mc_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       reserv4;  
    unsigned char       rts_rcvd;  
    unsigned char       reserv5;  
    unsigned short      max_len;  
    unsigned short      dlen;  
    unsigned char FAR * dptr;  
    unsigned char       reserv6[5];  
};   

Membres

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

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

Réserve2
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 MC_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 :

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

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

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

• AP_DATA_COMPLETE indique, pour MC_RECEIVE_IMMEDIATE dans les conversations mappées, que le tp local a reçu un enregistrement de données complet ou la dernière partie d’un enregistrement de données. Lors de la réception de cette valeur, le tp local réédite normalement MC_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é libérée en réponse à MC_DEALLOCATE émis par le tp partenaire.

• AP_DATA_INCOMPLETE indique pour MC_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). Lors de la réception de cette valeur, le tp local réédite normalement MC_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 MC_SEND_DATA pour commencer à envoyer des données.

  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.

• AP_NO spécifie que les indicateurs doivent être retournés individuellement sur des appels distincts du verbe.

• AP_YES spécifie 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.

  Les données sont le dernier enregistrement de données avant l’indicateur status.

  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 MC_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 MC_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 Microsoft Windows et l’environnement graphique Windows, cette valeur ne doit pas dépasser la longueur de la mémoire tampon pour contenir les données reçues.

  Pour le système d’exploitation OS/2, le décalage de dptr plus la valeur de max_len ne doit pas dépasser la taille du segment de données.

  En émettant MC_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, recherche une 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 et l’environnement graphique 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.

  Pour le système d’exploitation OS/2, la mémoire tampon de données doit résider sur un segment partagé sans nom, qui est alloué par la fonction DosAllocSeg avec des indicateurs 1. La mémoire tampon de données doit être entièrement adaptée au segment de 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_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 MC_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 correspondait pas à un identificateur de conversation attribué par APPC.

  AP_BAD_TP_ID

  Code de retour secondaire ; la valeur de tp_id ne correspondait 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 plus longue que le segment alloué pour contenir la mémoire tampon.

  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 MC_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 ; la demande d’allocation a spécifié des données PIP, mais soit le tp partenaire n’a pas besoin de ces données, soit l’unité lu 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é dans la demande d’allocation n’a pas été accepté par l’unité lu partenaire.

  AP_SYNC_LEVEL_NOT_SUPPORTED

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

  AP_TP_NAME_NOT_RECOGNIZED

  Code de retour secondaire ; l’unité 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 ; l’unité lu distante a rejeté la demande d’allocation, car elle n’a pas pu démarrer le TP du 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 ; l’unité lu distante a rejeté la demande d’allocation, car elle n’a pas pu démarrer le TP du 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_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. N’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 seule 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 MC_SEND_ERROR 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 ; tandis que dans l’état RECEIVE, PENDING, PENDING_POST, CONFIRM, CONFIRM_SEND ou CONFIRM_DEALLOCATE, le TP partenaire a émis MC_SEND_ERROR. Les données envoyées mais pas encore reçues sont purgées.

  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 à 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
  Code de retour principal ; la conversation a été libérée pour l’une des raisons suivantes :

• Le tp partenaire a émis des MC_DEALLOCATE avec dealloc_type défini sur AP_ABEND.

• Le TP partenaire a rencontré un ABEND, ce qui a entraîné l’unité lu partenaire à envoyer une demande de MC_DEALLOCATE .

Remarques

Le TP local reçoit des données via le processus suivant :

1. Le TP local émet un verbe de réception jusqu’à ce qu’il termine la réception d’une unité complète de données. Les données reçues sont un enregistrement de données.

   Le TP local peut avoir besoin d’émettre le verbe de réception plusieurs fois afin de 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 les manipuler.

   Les verbes de réception sont MC_RECEIVE_AND_POST, MC_RECEIVE_AND_WAIT et MC_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é l’envoi des données ou attend une confirmation, status informations (disponibles via what_rcvd) indiquent 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.