Prepare_To_Receive (CPI-C)

L’appel Prepare_To_Receive (nom de fonction CMPTR) modifie l’état de la conversation pour le programme local de l’envoi à la réception.

Syntaxe

  
CM_ENTRY Prepare_To_Receive(   
  unsigned char FAR *conversation_ID,    
  CM_INT32 FAR *return_code              
);  

Paramètres

conversation_ID
Paramètre fourni. Spécifie l’identificateur de la conversation. La valeur de ce paramètre a été retournée par Initialize_Conversation ou Accept_Conversation.

return_code
Code retourné à partir de cet appel. Les codes de retour valides sont répertoriés plus loin dans cette rubrique.

Codes de retour

CM_OK
Code de retour principal ; l’appel a été exécuté avec succès.

CM_OPERATION_NOT_ACCEPTED
Code de retour principal ; une opération précédente sur cette conversation est incomplète.

CM_OPERATION_INCOMPLETE
Code de retour principal ; l’opération n’est pas terminée (le mode de traitement est non bloquant uniquement) et est toujours en cours. Le programme peut émettre Wait_For_Conversation pour attendre la fin de l’opération, ou Cancel_Conversation pour annuler l’opération et la conversation. si Specify_Windows_Handle a été appelée, l’application doit attendre une notification par un Windows Microsoft®® et ne pas appeler Wait_For_Conversation.

CM_PROGRAM_PARAMETER_CHECK
Code de retour principal ; la valeur spécifiée par conversation_ID n’est pas valide.

CM_PROGRAM_STATE_CHECK
Code de retour principal ; l’un des éléments suivants s’est produit :

  • L’état de la conversation n’est pas SEND ou SEND_PENDING.

  • Pour une conversation de base, la conversation est à l’état d’envoi. Toutefois, le programme n’a pas fini d’envoyer un enregistrement logique.

    Ces codes de retour peuvent se produire si le type de la préparation à la réception de conversations est défini sur CM_PREP_TO_RECEIVE_CONFIRM ou si le type de préparation à la réception est défini sur CM_PREP_TO_RECEIVE_SYNC_LEVEL et que le niveau de synchronisation des conversations est défini sur CM_CONFIRM.

    CM_PRODUCT_SPECIFIC_ERROR
    Code de retour principal ; une erreur spécifique au produit s’est produite et a été consignée dans le journal des erreurs des produits.

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

    CM_PIP_NOT_SPECIFIED_CORRECTLY
    Code de retour principal ; la demande d’allocation a été rejetée par un programme de transaction LU 6,2 non-CPI-C. Le programme partenaire requiert une ou plusieurs variables de données PIP, qui ne sont pas prises en charge par CPI-C.

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

    CM_SYNC_LEVEL_NOT_SUPPORTED_PGM
    Code de retour principal ; le programme partenaire ne prend pas en charge le niveau de synchronisation spécifié dans la demande d’allocation.

    CM_TPN_NOT_RECOGNIZED
    Code de retour principal ; le LU partenaire ne reconnaît pas le nom du programme spécifié dans la demande d’allocation.

    CM_TP_NOT_AVAILABLE_NO_RETRY
    Code de retour principal ; le LU partenaire ne peut pas démarrer le programme spécifié dans la demande d’allocation en raison d’une condition 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.

    CM_TP_NOT_AVAILABLE_RETRY
    Code de retour principal ; le LU partenaire ne peut pas démarrer le programme spécifié dans la demande d’allocation en raison d’une condition temporaire. La raison de l’erreur peut être consignée sur le nœud distant. Réessayez l’allocation.

    CM_PROGRAM_ERROR_PURGING
    Code de retour principal ; l’un des éléments suivants s’est produit :

  • Dans l’État RECEIVE ou CONFIRM, le programme partenaire a émis Send_Error. Les données envoyées mais pas encore reçues sont purgées.

  • Dans SEND_PENDING État avec la direction d’erreur définie sur CM_RECEIVE_ERROR, le programme partenaire a émis Send_Error. Les données n’ont pas été purgées.

    CM_RESOURCE_FAILURE_NO_RETRY
    Code de retour principal ; l’un des éléments suivants s’est produit :

  • La conversation a été interrompue prématurément en raison d’une condition permanente. N’effectuez pas de nouvelle tentative tant que l’erreur n’a pas été corrigée.

  • Le programme partenaire n’a pas désalloué la conversation avant de se terminer normalement.

    CM_RESOURCE_FAILURE_RETRY
    Code de retour principal ; la conversation a été interrompue prématurément en raison d’une condition temporaire, telle que la défaillance d’un modem. Réessayez la conversation.

    CM_DEALLOCATED_ABEND
    Code de retour principal ; la conversation a été désallouée pour l’une des raisons suivantes :

  • Le programme distant a émis une désallocation avec le paramètre de type défini sur CM_DEALLOCATE_ABEND, ou le lu distant s’est vu en raison d’une condition de fin anormale du programme distant. Si la conversation pour le programme distant était en état de réception lors de l’émission de l’appel, les informations envoyées par le programme local et qui n’ont pas encore été reçues par le programme distant sont purgées.

  • Le TP distant s’est arrêté normalement mais n’a pas désalloué la conversation avant de se terminer. Les services de nœud au niveau de l’unité logique distante désalloué la conversation pour le compte du TP distant.

    CM_DEALLOCATED_ABEND_SVC
    Code de retour principal ; la conversation a été désallouée pour l’une des raisons suivantes :

  • Le programme partenaire a émis la désallocation avec le paramètre de type défini sur ABEND_SVC.

  • Le programme partenaire n’a pas désalloué la conversation avant de se terminer.

    Si la conversation est à l’état de réception pour le programme partenaire lorsque cet appel est émis par le programme local, les données envoyées par le programme local et qui ne sont pas encore reçues par le programme partenaire sont purgées.

    CM_DEALLOCATED_ABEND_TIMER
    Code de retour principal ; la conversation a été désallouée, car le programme partenaire a émis la désallocation avec le paramètre de type défini sur ABEND_TIMER. Si la conversation est à l’état de réception pour le programme partenaire lorsque cet appel est émis par le programme local, les données envoyées par le programme local et qui ne sont pas encore reçues par le programme partenaire sont purgées.

    CM_SVC_ERROR_PURGING
    Code de retour principal ; dans l’état d’envoi, le programme partenaire ou le LU partenaire a émis Send_Error avec le paramètre de type défini sur SVC. Les données envoyées au programme partenaire ont peut-être été purgées.

    Modifications d’État

    La conversation peut être dans un état d’envoi ou de SEND_PENDING.

    Les changements d’État, résumés dans le tableau suivant, sont basés sur la valeur du paramètre return_code .

return_code Nouvel État
CM_OK RECEIVE
CM_PROGRAM_ERROR_PURGING RECEIVE
CM_SVC_ERROR_PURGING RECEIVE
CM_CONVERSATION_TYPE_MISMATCH RESET
CM_PIP_NOT_SPECIFIED_CORRECTLY RESET
CM_SECURITY_NOT_VALID RESET
CM_SYNC_LEVEL_NOT_SUPPORTED_PGM RESET
CM_TPN_NOT_RECOGNIZED RESET
CM_TP_NOT_AVAILABLE_NO_RETRY RESET
CM_TP_NOT_AVAILABLE_RETRY RESET
CM_DEALLOCATED_ABEND RESET
CM_RESOURCE_FAILURE_NO_RETRY RESET
CM_RESOURCE_FAILURE_RETRY RESET
CM_DEALLOCATED_ABEND_SVC RESET
CM_DEALLOCATED_ABEND_TIMER RESET
Tous les autres Aucun changement

Avant de modifier l’état de la conversation, cet appel effectue l’équivalent de l’un des éléments suivants :

  • L’appel de vidage , qui envoie le contenu de la mémoire tampon des unités logiques d’envoi au programme et au lu du partenaire, si l’une des conditions suivantes est remplie :

    • Le type de la préparation à la réception des conversations est défini sur CM_PREP_TO_RECEIVE_FLUSH.

    • Le type de préparation de la réception des conversations est défini sur CM_PREP_TO_RECEIVE_SYNC_LEVEL et le niveau de synchronisation des conversations est défini sur CM_NONE.

  • L’appel Confirm , en envoyant le contenu de la mémoire tampon d’envoi lus locale et une demande de confirmation au programme partenaire, si l’une des conditions suivantes est remplie :

    • Le type de la préparation à la réception des conversations est défini sur CM_PREP_TO_RECEIVE_CONFIRM.

    • Le type de préparation de la réception des conversations est défini sur CM_PREP_TO_RECEIVE_SYNC_LEVEL et le niveau de synchronisation des conversations est défini sur CM_CONFIRM.

    Le type de préparation à la réception est défini par Set_Prepare_To_Receive_Type; le niveau de synchronisation est défini par Set_Sync_Level.

    La conversation ne peut pas être modifiée pour envoyer ou SEND_PENDING pour le programme partenaire tant que le programme partenaire n’a pas reçu l’une des valeurs suivantes par le biais du paramètre status_received de l’appel de réception :

  • CM_SEND_RECEIVED

  • CM_CONFIRM_SEND_RECEIVED et réponses avec l’appel confirmé ou Send_Error

Remarques

Une fois que cet appel a été exécuté avec succès, le programme local peut recevoir des données.