PCertRes

NAME: PCertRes - SET PCertRes message data structures and routines

SYNOPSIS

#include <set_msg.h>

typedef struct PCertRes_ {
    asn1set__MessageWrapper    messageWrapper;
    asn1set__PCertResTBS       pCertResTBS;
    cert_identity              gatewaySignatureCID;
} *PCertRes;

PCertRes safe_cast_PCertRes(msg)
    set_msg            msg;             /* IN */

DESCRIPTION: PCertRes contains the data from a SET PCertRes message in native C form. See the asn_types.h and asn1set.h header files for the declarations of the various types. See the SET specification for a description of individual fields.

FIELDS

A call to make_set_msg() results in the protocol layer filling in the following fields:

 *    messageWrapper.messageHeader.version
 *    messageWrapper.messageHeader.date
 *    messageWrapper.messageHeader.messageIDs
 *    messageWrapper.messageHeader.rrPID
 *    messageWrapper.messageHeader.swIdent
 *    messageWrapper.message._choice
 *    pCertResTBS.pCertRRTags
 *    pCertResTBS.pCertResItemSeq->pCertResItem.pCertCode
 *    pCertResTBS.pCertResItemSeq->pCertResItem.mThumbs (optional)
 *    pCertResTBS.brandCRLIdentifierSeq (optional)

It is unwise for applications to change the contents of the fields filled in by the protocol layer.

After calling make_set_msg(), gateway software must fill in the following required fields:

 *    gatewaySignatureCID

Non-required fields may be left empty at the discretion of the gateway application, subject to any business constraints placed on the application.

CACHING

Payment Gateway

      STATE_PCERTREQ_RRPID           get
      STATE_RRTAGS                   get
      STATE_THUMBS                   get

Merchant

      STATE_PCERTREQ_RRPID           get

RETURN VALUES: On success, safe_cast_PCertRes() returns a pointer to a PCertRes data structure. Objects of type set_msg that were not created with message type asn1set__Message__pCertRes will cause safe_cast_PCertRes() to fail. On failure, safe_cast_PCertRes() returns a 0 pointer.

SEE ALSO: set_msg, PCertReq, CapReq, CapRes, PInitReq, PInitRes, PReq, PRes

NOTES: There is a difference between non-required and optional. Non-required fields may be omitted according to the SET protocol. Optional fields may be omitted according to ASN.1 encoding rules. In some messages, a field may be optional according to ASN.1, but still required by the SET protocol. In these cases, it is incumbent on the application to fill in these fields.
Optional fields that are filled in require an application of the SET_PRESENT() macro. See documentation on ASN.1/DER runtime types for additional information.

EXAMPLE

A more complete, explicated example is provided in the Implementor's Guide.

    msg_type = asn1set__Message__pCertRes;
    status = make_set_msg(app_ctx, heap, msg_type, &response, msg_id);
    assert(status == NO_ERROR);

    pCertRes = safe_cast_PCertRes(response);
    assert(pCertRes != 0);
   
    pCertRes->messageWrapper.messageHeader.swIdent._choice = asn1set__SWIdent__visibleString;
    pCertRes->messageWrapper.messageHeader.swIdent.u.visibleString = "AcquirerServ v0.3b";

    /* ... */

    status = send_set_msg(app_ctx, heap, response, outstream)
    assert(status == NO_ERROR);

BUGS: This document describes a beta implementation. The information contained in this document may be incomplete and is subject to change.