PTANC - Partner Domain Control Blocks

  
  
  
  This copybook includes definitions for the anchor block, the state
  block, the pool block and all trace ids used by the domain. At
  present this is the only copybook for the PT domain. Everything is
  in a single copybook because this domain is so small. In time
  different definitions may be separated out into separate copybooks
  as the domain grows.
  
  --------------------------------------------------------------------
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 28 PT_ANCHOR_BLOCK
(0) CHARACTER 8 PTANC_EYECATCHER Eyecatcher
(8) UNSIGNED 4 PTANC_LENGTH Length of anchor block
(C) CHARACTER 8 PTANC_STATE_STG_POOL Storage manager subpool
(14) CHARACTER 4 PTANC_POOL_DIR_TOKEN Dir mgr token for pools
(18) CHARACTER 4 PTANC_STATE_DIR_TOKEN Dir mgr token for states 
  --------------------------------------------------------
  Pool block
  --------------------------------------------------------
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 28 PTTW_POOL_BLOCK
(0) CHARACTER 8 PTTWPB_EYECATCHER Eyecatcher
(8) UNSIGNED 4 PTTWPB_LENGTH Length of block
(C) UNSIGNED 4 PTTWPB_STATE State of the pool
(10) CHARACTER 8 PTTWPB_NAME Pool name
(18) UNSIGNED 4 PTTWPB_USECOUNT Count of state tokens 
  --------------------------------------------------------
  State block
  --------------------------------------------------------
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 76 PTTW_STATE_BLOCK
(0) CHARACTER 8 PTTWSB_EYECATCHER Eyecatcher
(8) UNSIGNED 4 PTTWSB_LENGTH Length of block
(C) UNSIGNED 4 PTTWSB_STATE State of partnership
(10) ADDRESS 4 PTTWSB_SUSPENDTOK Suspend token
(14) CHARACTER 8 PTTWSB_DDTOKEN Dir mgr token
(1C) CHARACTER 8 PTTWSB_POOLTOKEN Pool token
(24) ADDRESS 4 PTTWSB_POOLPTR Pool block addr
(28) CHARACTER 4 PTTWSB_USERTOKEN User token
(2C) CHARACTER 16 PTTWSB_PARTNERS (2) A partner's defn
(2C) UNSIGNED 4 PTTWSB_TRIGSTATE Trigger state
(30) UNSIGNED 4 PTTWSB_COMPCODE Completion code
(34) CHARACTER 8 PTTWSB_XMTOK XM token

Constants

Table 4.
Len Type Value Name Description 
   Value of pttwpb_eyecatcher.
8 CHARACTER >PTTWPB PTTWPB_EYE_VALUE 
   Values for pttwpb_state. This is a list of all the
   states that the pool block can take.
   The numeric values of the pool, partnership and
   trigger states are different to one another so that
   any bug in the code which accidentally assigns a
   pool state to a partnership state (for instance)
   is more likely to show up.
4 DECIMAL 0 PTTWPB_STATE_UNDEFINED
4 DECIMAL 1 PTTWPB_STATE_EMPTY
4 DECIMAL 2 PTTWPB_STATE_NOT_EMPTY
4 DECIMAL 3 PTTWPB_STATE_QUIESCING 
   Value of pttwsb_eyecatcher.
8 CHARACTER >PTTWSB PTTWSB_EYE_VALUE 
   Values for pttwsb_state. This is a list of all the
   states that the state block can take.
4 DECIMAL 0 PTTWSB_STATE_UNDEFINED
4 DECIMAL 4 PTTWSB_STATE_CREATED
4 DECIMAL 5 PTTWSB_STATE_ PARTIALLY_MADE
4 DECIMAL 6 PTTWSB_STATE_MADE
4 DECIMAL 7 PTTWSB_STATE_DELETED 
   Values for pttwsb_trigstate. This is a list of all
   the states that each partner's trigger object can have.
4 DECIMAL 1 PTTWSB_TRIGSTATE_ UNDEFINED
4 DECIMAL 2 PTTWSB_TRIGSTATE_VALID
4 DECIMAL 4 PTTWSB_TRIGSTATE_ WAITING
4 DECIMAL 3 PTTWSB_TRIGSTATE_ TRIGGERED
4 DECIMAL 5 PTTWSB_TRIGSTATE_ RESUMED 
--------------------------------------------------------------
Trace point ids for PTDM in the range 0000 to 00FF.
--------------------------------------------------------------
2 NUMB HEX 0000 TID_PTDM_ENTRY
2 NUMB HEX 0001 TID_PTDM_EXIT
2 NUMB HEX 0002 TID_PTDM_RECOVERY
2 NUMB HEX 0003 TID_PTDM_ADD_SUBPOOL_ FAILED
2 NUMB HEX 0004 TID_PTDM_GETMAIN_ FAILED
2 NUMB HEX 0005 TID_PTDM_SET_ANCHOR_ FAILED
2 NUMB HEX 0006 TID_PTDM_CREATE_DIR_ FAILED
2 NUMB HEX 0007 TID_PTDM_ADD_GATE_ FAILED 
--------------------------------------------------------------
Trace point ids for PTTW in the range 0100 to 01FF.
--------------------------------------------------------------
2 NUMB HEX 0100 TID_PTTW_ENTRY
2 NUMB HEX 0101 TID_PTTW_EXIT
2 NUMB HEX 0102 TID_PTTW_EXC_INV_ FORMAT
2 NUMB HEX 0103 TID_PTTW_EXC_INV_ FUNCTION
2 NUMB HEX 0104 TID_PTTW_EXC_INV_ TIMED_OUT
2 NUMB HEX 0105 TID_PTTW_EXC_PURGED
2 NUMB HEX 0106 TID_PTTW_EXC_GETMAIN_ FAILED
2 NUMB HEX 0107 TID_PTTW_EXC_ADD_ ENTRY_FAILED
2 NUMB HEX 0108 TID_PTTW_EXC_DEL_ ENTRY_FAILED
2 NUMB HEX 0109 TID_PTTW_EXC_POOL_NOT_ FOUND
2 NUMB HEX 010A TID_PTTW_EXC_STATE_ NOT_FOUND
2 NUMB HEX 010B TID_PTTW_EXC_LOCATE_ FAILED
2 NUMB HEX 010C TID_PTTW_EXC_CORRUPT_ POOL
2 NUMB HEX 010D TID_PTTW_EXC_CORRUPT_ STATE
2 NUMB HEX 010E TID_PTTW_EXC_ADD_SUS_ FAILED
2 NUMB HEX 010F TID_PTTW_EXC_DEL_SUS_ FAILED
2 NUMB HEX 0110 TID_PTTW_EXC_INQ_TXN_ FAILED
2 NUMB HEX 0111 TID_PTTW_EXC_RESUME_ FAILED
2 NUMB HEX 0112 TID_PTTW_EXC_SUSPEND_ FAILED
2 NUMB HEX 0113 TID_PTTW_EXC_RESUME_ TIMED_OUT
2 NUMB HEX 0114 TID_PTTW_RECOVERY
2 NUMB HEX 0115 TID_PTTW_WHOAMI
2 NUMB HEX 0116 TID_PTTW_STATE_BLOCK_ FOUND
2 NUMB HEX 0117 TID_PTTW_TRIGSTATE_ CHANGE
2 NUMB HEX 0118 TID_PTTW_EXC_INV_STATE