ZXTR - XRF tracking record header

      CONTROL BLOCK NAME = DFHZXTR
      NAME OF MATCHING PLS CONTROL BLOCK = NONE
      DESCRIPTIVE NAME = CICS TS XRF tracking record header.
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1985, 2015 
      FUNCTION =
           Common part of records shipped to an XRF alternate
           to drive the tracking of various states.
      LIFETIME =
           Built by DFHTBSSP and the XRF catch-up transaction, and
           interpreted by DFHTCRP and DFHZXQO.
      STORAGE CLASS = Various.
      LOCATION = Various.
      INNER CONTROL BLOCKS =
           The tracking record contains a variable length data
           field which in some cases is a copy of the CICS catalog
           record.
      NOTES :
       DEPENDENCIES = S/370
       RESTRICTIONS = None.
       MODULE TYPE = Control block definition
     ------------------------------------------------------------------
      EXTERNAL REFERENCES = None.
        DATA AREAS = None.
        CONTROL BLOCKS = None.
        GLOBAL VARIABLES (Macro pass) = No sysgen globals.

Table 1.
Offset Hex	Type	Len	Name (Dim)	Description
(0)	STRUCTURE	*	XTR_RECORD	Tracking record sent from the ACTIVE to the ALTERNATE
(0)	UNSIGNED	2	XTR_ID	Indicates whether it is a CATCHUP or TRACKING type record.
(2)	BIT(8)	1	*	Flags
(3)	CHARACTER	1	XTR_TYPE	Defines what the tracking record contains
(4)	CHARACTER	*	XTR_KEY
(4)	UNSIGNED	1	XTR_KEY_LENGTH	Length of the key value. If this is 0 and XTR_ID is not XTR_ID_BROADCAST then this is the end-of-stream marker for a particular catchup. Any data will be ignored in this case.
(5)	CHARACTER	*	XTR_KEY_VALUE	A string that uniquely names the externalised object

Table 2.
Offset Hex	Type	Len	Name (Dim)	Description
(0)	STRUCTURE	*	XTR_DATA	Recovery record proper
(0)	UNSIGNED	2	XTR_DATA_LENGTH
(2)	CHARACTER	*	XTR_DATA_STRING	Contains the externalised object(s) and associated object.

           The following structure maps XTR_DATA_STRING when used
                     for tracking-control messages.
           In this case the following conventions exist:-
           (a) If XTR_ID is XTR_ID_BROADCAST then
               this is a start-of-stream record,
               which is the first record generated
               by a (new) active.
           (b) If XTR_ID is not XTR_ID_BROADCAST then
               this is a start-of-catchup record,
               and any backup waiting to do catchup
               may capture the value in XTR_ID which
               will be used in all subsequent records
               for this particular catchup.

Table 3.
Offset Hex	Type	Len	Name (Dim)	Description
(0)	STRUCTURE	*	XTR_XC_DATA
(0)	BIT(8)	1	*
(0)	1... ....		XTR_XC_STRM_WARM	Stream is cold
(1)	CHARACTER	1	* (*)	List of types in stream
(1)	CHARACTER	1	XTR_XC_TYPE_ELEM	Stream type

           The following structure maps XTR_DATA_STRING when used
                  for session-state tracking messages.

Table 4.
Offset Hex	Type	Len	Name (Dim)	Description
(0)	STRUCTURE	*	XTR_ST_DATA
(0)	CHARACTER	5	XTR_ST_SHORT	Basic section
(0)	CHARACTER	4	XTR_ST_SESS_NAME	Session/terminal name
(4)	CHARACTER	1	XTR_ST_REQUEST	Request being shipped
(5)	BIT(8)	1	XTR_ST_FLAGS_1
(5)	1... ....		XTR_ST_CAPABLE	XRF capable session
(6)	CHARACTER	*	XTR_ST_CORREL	Correlation id
(6)	UNSIGNED	1	XTR_ST_CORREL_LN	Length
(7)	CHARACTER	*	XTR_ST_CORREL_ID	Value

           This is now externalised

Table 5.
Offset Hex	Type	Len	Name (Dim)	Description
(0)	STRUCTURE	*	XTR_ST_LOG_DATA	Logon data
(0)	UNSIGNED	2	XTR_ST_LOGD_LEN	Length
(2)	CHARACTER	*	XTR_ST_LOGD_VAL	Value

Table 6.
Offset Hex	Type	Len	Name (Dim)	Description
(0)	STRUCTURE	*	XTR_ST_BIND	BIND-image
(0)	UNSIGNED	1	XTR_ST_BIMG_LEN	Length
(1)	CHARACTER	*	XTR_ST_BIMG_VAL	Value

Table 7.
Offset Hex	Type	Len	Name (Dim)
(0)	STRUCTURE	*	XTR_SN_DATA
(0)	CHARACTER	4	XTR_SN_SESS_NAME
(4)	UNSIGNED	1	XTR_SN_REP_N
(5)	CHARACTER	*	XTR_SN_REP

Constants

Table 8.
Len	Type	Value	Name	Description
4	DECIMAL	5	XTR_RECORD_SIZE
4	DECIMAL	16	XTR_MAX_KEYLEN	Maximum length of the obj
4	DECIMAL	2	XTR_DATA_SIZE
Used in XTR_ID
2	DECIMAL	0	XTR_ID_BROADCAST	General msg
2	DECIMAL	65535	XTR_ID_PENDING	XTR_ID_PENDING - used to indicate that a stream has been "opened" but nothing sent yet
Used in XTR_TYPE
1	CHARACTER	X	XTR_TYPE_CONTROL	Tracking control
1	CHARACTER	C	XTR_TYPE_ZC_CONTENTS	CONTENTS
1	CHARACTER	S	XTR_TYPE_ZC_SESSIONS	SESSIONS
1	CHARACTER	U	XTR_TYPE_SN	User ids
Used in RESPONSE
1	DECIMAL	0	XTR_RSP_NORMAL	Normal response
1	DECIMAL	8	XTR_RSP_ERROR	Error response
1	DECIMAL	4	XTR_RSP_SHUTDOWN	Shutdown
1	DECIMAL	1	XTR_RSP_ALL_GONE	No backups
4	DECIMAL	5	XTR_SN_DATA_SIZE
Values used in XTS_ST_REQUEST:-
1	CHARACTER	1	XTR_ST_REQ_BIND	BIND completed
1	CHARACTER	2	XTR_ST_REQ_FREED	Logon data freed
1	CHARACTER	3	XTR_ST_REQ_UNBND	UNBIND completed