WMS - XRF Message manager request

      CONTROL BLOCK NAME = DFHWMSPS
      DESCRIPTIVE NAME = CICS TS (XRF) Message manager request
                            interface block.
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1985 
      FUNCTION =
           Defines the format of the parameter block passed by the
           user of XRF message services.
           Since the user's parameter block is usually copied into
           a work queue element the definition of such an element,
           DFHWMQPS, includes an area to which this definition
           applies.
      LIFETIME =
           Created by caller of message services and lasts for the
           duration of the processing of the request.
      STORAGE CLASS =
           User choice.
      LOCATION =
           Usually in caller's LIFO.
      INNER CONTROL BLOCKS =
           None
      NOTES :
       DEPENDENCIES = S/370
       RESTRICTIONS =
             None
       MODULE TYPE = Control block definition
     ------------------------------------------------------------------
      EXTERNAL REFERENCES =
        DATA AREAS =
            None
        CONTROL BLOCKS =
            None
        GLOBAL VARIABLES (Macro pass) =
            None
     ------------------------------------------------------------------
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 24 DFHWMSPS XRF Message manager parameter block
(0) FULLWORD 4 WMSREQID Request Identifier
(4) BIT(8) 1 WMSRQFL1 Request flag byte 1
(4) 1... ....   WMSCRUCL CRUCIAL Message (PUTMSG)
(4) .111 1111   * Reserved
(5) BIT(8) 1 WMSRQFL2 Request flag byte 2
(5) 1... ....   WMSFORCE Harden message before returning (PUTMSG)
(5) .111 1111   * Reserved
(6) CHARACTER 2 WMSRC Response field
(8) ADDRESS 4 WMSDATAD Data area address
(C) HALFWORD 2 WMSDATSZ Size of data area
(E) HALFWORD 2 WMSDATLN Data length
(10) CHARACTER 8 WMSIVN Instance and version/queue
(10) FULLWORD 4 WMSINSTN Instance number
(14) FULLWORD 4 WMSVERSN Version no (PUTREQ, PUTRSP)
(14) CHARACTER 4 WMSQNAME Queue name (GETMSG, PUTMSG)
(18) CHARACTER 0 WMSEND 
       Response field
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 2 WMSRESP Response
(0) UNSIGNED 1 WMSRETC Return code
(1) UNSIGNED 1 WMSREASN Reason code

Constants

Table 3.
Len Type Value Name Description 
     Request Identifier (WMSREQID) definitions
4 DECIMAL 1 WMSPMSG PUTMSG
4 DECIMAL 2 WMSGMSG GETMSG
4 DECIMAL 3 WMSPREQ PUTREQ
4 DECIMAL 4 WMSPRSP PUTRSP 
     Return Codes (WMSRETC) definitions
1 DECIMAL 0 WMSNORML Normal
1 DECIMAL 4 WMSEXCPN Exception
1 DECIMAL 8 WMSFAIL Failed 
     Reason Codes (WMSREASN) definitions
                    If WMSRETC = WMSEXCP
1 DECIMAL 1 WMSNOXRF XRF not active
1 DECIMAL 2 WMSEOD End of data. We are about to take over. The active will send no more records.
1 DECIMAL 3 WMSSGNOF Backup has SIGNED OFF from XRF. No more records will be presented. 
                    If WMSRETC = WMSFAIL
1 DECIMAL 1 WMSINVRC Invalid request code
1 DECIMAL 2 WMSCLOSD Service closed
1 DECIMAL 3 WMSCANCL Task cancelled
1 DECIMAL 4 WMSDLERR Data length error. Either too large or -ve.
1 DECIMAL 5 WMSOVLAP ACTIVE reject non-crucial message rather than risk damaging a BACKUP. BACKUP lapped by ACTIVE message writer.
1 DECIMAL 6 WMSNODST No SIGNED-ON destination exists for this message
1 DECIMAL 7 WMSBUSY Message queue busy
1 DECIMAL 8 WMSCHECK Program check while copying message data.
1 DECIMAL 9 WMSABEND XRF TCB Abend
1 DECIMAL 10 WMSIOER Message dataset I/O error
1 DECIMAL 11 WMSFMTER Message dataset format error.
1 DECIMAL 12 WMSSEQER Message dataset sequence number error.
1 DECIMAL 13 WMSNACTV System not ACTIVE yet