NAME       : HCPMUCBK
 DESCRIPTION: Monitor User Control Block
 DSECT      : MUCBK
 FUNCTION   : Represents a user that has been connected to
              *MONITOR System Service.
              Storage type is sys perm.
 LOCATED BY : Data structure   Field location
              MUC_NEXT           field in MUCBK
              MUC_PREV           field in MUCBK
              MNDI_CONN_HEAD     field in MNDBK
              MNDI_CONN_TAIL     field in MNDBK
              MNDI_SEV_PURGEF_H  field in MNDBK
              MNDI_SEV_PURGEF_T  field in MNDBK
              MNDE_MAIL_H        field in MNDBK
              MNDS_MAIL_H        field in MNDBK
              MNDE_PC_HEAD       field in MNDBK
              MNDS_PC_HEAD       field in MNDBK
 CREATED BY : HCPMNICN - *MONITOR IUCV CONNECT processing
 DELETED BY : HCPMOIER - Process IUCV REPLY to Event Data Message
              HCPMOISR - Process IUCV REPLY to Sample Data Message
              HCPMXBCR - Process IUCV REPLY to Config Message
              HCPMXESU - Sever Monitor User's IUCV Path to *MONITOR
              HCPMOIRT - Process IUCV REPLY to Termination messages
 REFERENCES : none
 SERIALIZED : N/A
 RELOCATION CONSIDERATIONS : None
 COMPATIBILITY AND MIGRATION CONCERNS : The forward and backward
              pointers must occupy the first two words of this
              control block.

 MUCBK DSECT
Top of page

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      MUCBK          Monitor User Control Block
0000    0 Address      4 MUC_NEXT       Forward pointer to the next block
                                        on the chain - MUST BE FIRST IN
                                        BLOCK
0004    4 Address      4 MUC_PREV       Backward pointer to the prev
                                        block on the chain - MUST BE
                                        SECOND IN BLOCK
0008    8 Character    8 MUC_USERID     Userid
0010   16 Address      4 MUC_VMDBKAD    Address of user's VMDBK
      User Session Data
      These characteristics are established when the user connects to
     **MONITOR.
0014   20 Bitstring   26 MUC_SESSION (0)
                                        Static Session Data
      User Static Session Data. This does not change while the user is
      connected.
0014   20 Bitstring    1 MUC_MON_TYPE   Type of monitoring requested by
                                        user. At least one of these flags
                                        will be on. Serialized by the
                                        MND_CMD_LOCK
          1... ....      MUC_S_CONN     X'80' MUC_S_CONN Connected for
                                        sample data. This user is
                                        "eligible" for data messages if
                                        he is NOT on the sample pending-
                                        config list (MNDS_PC_LIST).
          .1.. ....      MUC_E_CONN     X'40' MUC_E_CONN Connected for
                                        EVENT data ... this user is
                                        "eligible" for data messages if
                                        he is NOT on the event pending-
                                        config list (MNDE_PC_LIST).
0015   21 Bitstring    1 *              Reserved for IBM use
0016   22 Bitstring    8 MUC_IUCV (0)   Serialized by the MND_CMD_LOCK
0016   22 Address      2 MUC_PATHID     IUCV-assigned pathid for the path
                                        between *MONITOR and this user's
                                        virtual machine
0018   24 Signed       1 MUC_MSGLIM (0) IUCV message limit information
0018   24 Bitstring    2 MUC_I_MSGLIM   IUCV message limit for this path
                                        established when *MONITOR does
                                        the IUCV ACCEPT for this path
001A   26 Bitstring    2 *              Reserved for IBM use
      User Dynamic Session Data. This can change while the user is
      connected.
001C   28 Bitstring   16 MUC_USER_STAT (0)
                                        Dynamic session data
001C   28 Bitstring    1 MUC_SAMPLE_STA (0)
                                        Sample Status
001C   28 Bitstring    1 MUC_SAMPLE_FLG Sample Status Flags
          1... ....      MUC_S_HC       X'80' MUC_S_HC Holding sample
                                        config records. Serialized by
                                        MND_CMD_LOCK
001D   29 Bitstring    1 MUC_EVENT_STAT (0)
                                        Event Status
001D   29 Bitstring    1 MUC_EVENT_FLGS Event flags
          1... ....      MUC_E_HC       X'80' MUC_E_HC Holding event
                                        config records. Serialized by
                                        MND_CMD_LOCK
001E   30 Bitstring    1 MUC_QUIS (0)
001E   30 Bitstring    1 MUC_QUIS_FLAGS Quiesce flags
          1... ....      MUC_QUIESCE    X'80' MUC_QUIESCE User's path is
                                        quiesced. Serialized by
                                        MND_CMD_LOCK and the
                                        MNDE_MAIL_LOCK.
001F   31 Bitstring    1 *              Reserved for IBM use
0020   32 Bitstring    8 MUC_SEVER (0)
0020   32 Bitstring    1 MUC_SEVER_FLGS Sever flags
0021   33 Bitstring    3 *              Reserved for IBM use.
0024   36 Signed       4 MUC_PURGEF_CT  Count of "purge-failed" messages
                                        - i.e. the number of messages
                                        that *MONITOR attempted to purge
                                        but failed to do so.
0028   40 Signed       4 MUC_MSG_CT     Count of outstanding messages for
                                        this user (config, data and
                                        termination)
      Managing Event messages
002C   44 Bitstring   60 MUC_EVENT (0)
002C   44 Bitstring   30 MUC_EVENT_DATA (0)
                                        Event data mail list
002C   44 Address      4 MUC_EMAIL_NEXT Pointer to next MUCBK on event
                                        mail list (MNDE_MAIL). This field
                                        will contain hex FF's if this
                                        user is not on the mail list.
                                        Serialized by MNDE_MAIL_LOCK plus
                                        the MND_CMD_LOCK for updating.
                                        Either lock is sufficient for
                                        read only access.
0030   48 Address      4 MUC_EMAIL_PREV Pointer to previous MUCBK on the
                                        event mail list (MNDE_MAIL). This
                                        field will contain hex FF's if
                                        this user is not on the mail
                                        list. Serialized by
                                        MNDE_MAIL_LOCK plus the
                                        MND_CMD_LOCK for updating. Either
                                        lock is sufficient for read only
                                        access.
0034   52 Bitstring   11 MUC_ED_SENT (0)
                                        Chain of MMLBKs, each
                                        representing a message sent to
                                        the user for event data and for
                                        which *MONITOR is now awaiting a
                                        reply. Also mapped by
                                        MUC_COM_DATA.
0034   52 Address      4 MUC_ED_SENT_H  Pointer to the head of this
                                        user's list of MMLBKs for sent
                                        EVENT data messages. When the
                                        list is empty, this field points
                                        to itself
0038   56 Address      4 MUC_ED_SENT_T  Pointer to the tail of this
                                        user's list of MMLBKs for sent
                                        EVENT data messages. When the
                                        list is empty this field contains
                                        the address of the head,
                                        MUC_ED_SEND_H.
003C   60 Address      2 MUC_ED_SENT_CT count of EVENT data messages
                                        outstanding for this user
003E   62 Bitstring    1 *              Reserved for IBM use
003F   63 Bitstring    1 *              Reserved for IBM use
0040   64 Bitstring   10 MUC_ED_PEND (0)
                                        This is a circular list of MMLBKs
                                        for event data messages that are
                                        pending for this user. Serialized
                                        by MNDI_EV_SENT.MND_LOCK
0040   64 Address      4 MUC_ED_PEND_H  Pointer to the head of this
                                        user's list of MMLBKs for pending
                                        event data messages. When the
                                        list is empty this field points
                                        to itself.
0044   68 Address      4 MUC_ED_PEND_T  Pointer to the tail of this
                                        user's list of MMLBKs for pending
                                        event data messages. When the
                                        list is empty this field contains
                                        the address of the head,
                                        MUC_ED_PEND_H.
0048   72 Address      2 MUC_ED_PEND_CT Count of pending EVENT data
                                        messages for this user.
004A   74 Bitstring    2 *              Reserved for IBM use
       EVENT config messages
004C   76 Bitstring   16 MUC_EVENT_CONF (0)
                                        These fields are serialized by
                                        the MND_CMD_LOCK.
004C   76 Address      4 MUC_EPC_NEXT   Pointer to next MUCBK on event
                                        Pending-Config list
                                        (MNDE_PC_LIST). This field will
                                        contain hex FF's if this user is
                                        not on the list.
0050   80 Address      4 MUC_EPC_PREV   Pointer to previous MUCBK on
                                        event Pending-Config list
                                        (MNDE_PC_LIST). This field will
                                        contain hex FF's if this user is
                                        not on the list.
0054   84 Bitstring    8 MUC_EC_SENT (0)
                                        A chain of MMLBKs, each
                                        representing a message sent to
                                        the user for event config data
                                        and for which *MONITOR is now
                                        awaiting a reply. Also mapped by
                                        MUC_COM_CONFIG.
0054   84 Address      4 MUC_EC_SENT_H  Pointer to head of this user's
                                        list of EVENT config MMLs. When
                                        the list is empty, this field
                                        points to itself. Note: if this
                                        list is not empty, that does NOT
                                        necessarily mean that this user
                                        is holding the config area.
                                        However, only 1 MML at a time can
                                        be "active" - any others on the
                                        list represent messages that
                                        monitor tried to purge. (See
                                        MMLBK).
0058   88 Address      4 MUC_EC_SENT_T  Pointer to tail of this user's
                                        list of EVENT config MMLs. When
                                        the list is empty, this field
                                        contains the address of the head,
                                        MUC_EC_SENT_H.
      EVENT termination messages
005C   92 Bitstring   12 MUC_EVENT_TERM (0)
                                        These fields are serialized by
                                        the MND_CMD_LOCK.
005C   92 Bitstring    8 MUC_ET_SENT (0)
005C   92 Address      4 MUC_ET_SENT_H  Pointer to head of this user's
                                        list of EVENT termination MMLs.
                                        (Note: only 1 MML at a time can
                                        be "active" - any others on the
                                        list represent messages that
                                        monitor tried to purge (See
                                        MMLBK). When the list is empty,
                                        this field points to itself.
0060   96 Address      4 MUC_ET_SENT_T  Pointer to tail of this user's
                                        list of EVENT termination
                                        messages. When the list is empty,
                                        this field contains the address
                                        of the head, MUC_ET_SENT_H.
0064  100 Bitstring    1 MUC_ET_PEND    Termination flag
          1... ....      MUC_ET_PEND_FL X'80' MUC_ET_PEND_FL Pending flag
                                        for termination message. ON =
                                        user needs an event termination
                                        message. A termination message
                                        will be sent when the user
                                        resumes his path.
0065  101 Bitstring    3 *              Reserved for IBM use
      Managing SAMPLE messages
0068  104 Bitstring   48 MUC_SAMPLE (0) Sample data e-mail list
0068  104 Bitstring    1 MUC_SAMPLE_DAT (0)
                                        Sample data messages
0068  104 Address      4 MUC_SMAIL_NEXT Pointer to next MUCBK on sample
                                        mail list (MNDS_MAIL). This field
                                        will contain hex FF's if this
                                        user is not on the mail list.
                                        Serialized by MND_CMD_LOCK.
006C  108 Address      4 MUC_SMAIL_PREV Pointer to previous MUCBK on
                                        sample mail list (MNDS_MAIL).
                                        This field will contain hex FF's
                                        if this user is not on the mail
                                        list. Serialized by MND_CMD_LOCK.
0070  112 Bitstring   11 MUC_SD_SENT (0)
                                        Chain of MMLBKs, each
                                        representing a message sent to
                                        the user for sample data and for
                                        which *MONITOR is now awaiting a
                                        reply. Also mapped by
                                        MUC_COM_DATA.
0070  112 Address      4 MUC_SD_SENT_H  Pointer to the head of this
                                        user's list of MMLs for sent
                                        SAMPLE data messages. When the
                                        list is empty, this field points
                                        to itself.
0074  116 Address      4 MUC_SD_SENT_T  Pointer to the tail of this
                                        user's list of MMLs for sent
                                        SAMPLE data messages. When the
                                        list is empty, this field points
                                        to the head, MUC_SD_SENT_H.
0078  120 Address      2 MUC_SD_SENT_CT Count of SAMPLE data messages
                                        (MMLs) outstanding for this path
007A  122 Bitstring    1 MUC_SD_LOST    Sample flags
          1... ....      MUC_SD_LOSG_BI X'80' MUC_SD_LOSG_BI The user has
                                        miss one or more while his path
                                        was quiesced.
007B  123 Bitstring    1 *              Reserved for IBM use
      SAMPLE config messages
007C  124 Bitstring   16 MUC_SAMPLE_CON (0)
                                        Sample configuration data e-mail
                                        list Serialized by MND_CMD_LOCK.
007C  124 Address      4 MUC_SPC_NEXT   Pointer to next MUCBK on sample
                                        pending-config list
                                        (MNDS_PC_LIST). This field will
                                        contain hex FF's if this user is
                                        not on the list (ie. if this user
                                        is not waiting foe sample config
                                        records.)
0080  128 Address      4 MUC_SPC_PREV   Pointer to previous MUCBK on the
                                        sample pending-config list
                                        (MNDS_PC_LIST). This field will
                                        contain hex FFs if this user is
                                        not on the list (ie. if user is
                                        not waiting for sample config
                                        records.
0084  132 Bitstring    8 MUC_SC_SENT (0)
                                        Chain of MMLBKs, each
                                        representing a message sent to
                                        the user for sample config data
                                        and for which *MONITOR is now
                                        awaiting a reply. Also mapped by
                                        MUC_COM_CONFIG.
0084  132 Address      4 MUC_SC_SENT_H  Pointer to head of this user's
                                        list of SAMPLE config MMLs.
                                        (Note: only 1 MML at a time can
                                        be "active" - any others on the
                                        list represent messages that
                                        monitor tried to purge. See
                                        MMLBK). When the list is empty
                                        this field points to itself.
0088  136 Address      4 MUC_SC_SENT_T  Pointer to tail of this user's
                                        list of SAMPLE config MMLs. When
                                        the list is empty, this field
                                        points to the head,
                                        MUC_SC_SENT_H.
008C  140 Bitstring   12 MUC_SAMPLE_TER (0)
                                        Outstanding sample termination
                                        data
008C  140 Bitstring    8 MUC_ST_SENT (0)
                                        Circular list of MMLBKs for sent
                                        sample termination messages.
008C  140 Address      4 MUC_ST_SENT_H  Pointer to head of this user's
                                        list of SAMPLE termination MMLs.
                                        (Note: only 1 MML at a time can
                                        be "active" - any others on the
                                        list represent messages that
                                        monitor tried to purge. See
                                        MMLBK). When the list is empty
                                        this field points to itself.
0090  144 Address      4 MUC_ST_SENT_T  Pointer to tail of this user's
                                        list of SAMPLE termination
                                        messages. When the list is empty,
                                        this field points to the head,
                                        MUC_ST_SENT_H.
0094  148 Bitstring    1 MUC_ST_PEND    Termindation flags
          1... ....      MUC_ST_PEND_FL X'80' MUC_ST_PEND_FL Pending flag
                                        for termination A termination
                                        message will be sent when when
                                        user resumes his path.
0095  149 Bitstring    3 *              Reserved for IBM use
          00000098       MUC$END        *
          00000013       MUCSIZE        (MUC$END-MUCBK+7)/8 MUCBK size in
                                        doublewords
        MUC_COM_DATA - Map for sample and event data sent fields.
                       Common mapping for MUC_ED_SENT or MUC_SD_SENT.


 MUC_COM_DATA DSECT
Top of page

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      MUC_COM_DATA   Monitor User Control Block
0000    0 Address      4 MUC_COMD_SENTH Pointer to the head of this
                                        user's list of MMLs for sent data
                                        messages
0004    4 Address      4 MUC_COMD_SENTT Pointer to the tail of this
                                        user's list of MMLs for sent data
                                        messages
0008    8 Address      2 MUC_COMD_SENTC Count of outstanding data
                                        messages for this user.
000A   10 Bitstring    1 MUC_COMD_LOST  Messages flags
        MUC_COM_CONFIG - Map for sample and event config sent fields.
                         Common mapping for MUC_EC_SENT or MUC_SC_SENT.


 MUC_COM_CONFIG DSECT
Top of page

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      MUC_COM_CONFIG Monitor User Control Block
0000    0 Address      4 MUC_COMC_SENTH Pointer to the head of this
                                        user's list of MMLs for sent
                                        config messages
0004    4 Address      4 MUC_COMC_SENTT Pointer to the tail of this
                                        user's list of MMLs for sent
                                        config messages
      MUC_COM_TERM - Map for sample and event data TERMINATION fields.
                  Common mapping for MUC_EVENT_TERM and MUC_SAMPLE_TERM


 MUC_COM_TERM DSECT
Top of page

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      MUC_COM_TERM   Monitor User Control Block
0000    0 Address      4 MUC_COMT_SENTH Pointer to the head of this
                                        user's list of MMLs for
                                        termination messages
0004    4 Address      4 MUC_COMT_SENTT Pointer to the tail of this
                                        user's list of MMLs for
                                        termination messages
0008    8 Bitstring    1 MUC_COMT       Termination flags
          1... ....      MUC_COMT_FLAG  X'80' MUC_COMT_FLAG Termination
                                        message pending
0009    9 Bitstring    3 *              Reserved for IBM use

          
*** MUCBK - Monitor User Control Block
*
*     +---------------------------+---------------------------+
*   0 |         MUC_NEXT          |         MUC_PREV          |
*     +---------------------------+---------------------------+
*   8 |                      MUC_USERID                       |
*     +---------------------------+------+------+-------------+
*  10 |       MUC_VMDBKAD         |(014) |//////| MUC_PATHID  |
*     +-------------+-------------+------+------+------+------+
*  18 |MUC_I_MSGLIM |/////////////|(01C) |(01D) |(01E) |//////|
*     +------+------+-------------+------+------+------+------+
*  20 |(020) |////////////////////|      MUC_PURGEF_CT        |
*     +------+--------------------+---------------------------+
*  28 |        MUC_MSG_CT         |      MUC_EMAIL_NEXT       |
*     +---------------------------+---------------------------+
*  30 |      MUC_EMAIL_PREV       |      MUC_ED_SENT_H        |
*     +---------------------------+-------------+------+------+
*  38 |      MUC_ED_SENT_T        |:_ED_SENT_CT |//////|//////|
*     +---------------------------+-------------+------+------+
*  40 |      MUC_ED_PEND_H        |      MUC_ED_PEND_T        |
*     +-------------+-------------+---------------------------+
*  48 |:_ED_PEND_CT |/////////////|       MUC_EPC_NEXT        |
*     +-------------+-------------+---------------------------+
*  50 |       MUC_EPC_PREV        |      MUC_EC_SENT_H        |
*     +---------------------------+---------------------------+
*  58 |      MUC_EC_SENT_T        |      MUC_ET_SENT_H        |
*     +---------------------------+------+--------------------+
*  60 |      MUC_ET_SENT_T        |(064) |////////////////////|
*     +---------------------------+------+--------------------+
*  68 |      MUC_SMAIL_NEXT       |      MUC_SMAIL_PREV       |
*     +---------------------------+---------------------------+
*  70 |      MUC_SD_SENT_H        |      MUC_SD_SENT_T        |
*     +-------------+------+------+---------------------------+
*  78 |:_SD_SENT_CT |(07A) |//////|       MUC_SPC_NEXT        |
*     +-------------+------+------+---------------------------+
*  80 |       MUC_SPC_PREV        |      MUC_SC_SENT_H        |
*     +---------------------------+---------------------------+
*  88 |      MUC_SC_SENT_T        |      MUC_ST_SENT_H        |
*     +---------------------------+------+--------------------+
*  90 |      MUC_ST_SENT_T        |(094) |////////////////////|
*     +---------------------------+------+--------------------+
*  98
*
*** MUCBK - Monitor User Control Block
          
*** MUC_COM_DATA - Monitor User Control Block
*
*     +---------------------------+---------------------------+
*   0 |      MUC_COMD_SENTH       |      MUC_COMD_SENTT       |
*     +-------------+------+------+---------------------------+
*   8 |:_COMD_SENTC |(00A) | B
*     +-------------+------+
*
*** MUC_COM_DATA - Monitor User Control Block
          
*** MUC_COM_CONFIG - Monitor User Control Block
*
*     +---------------------------+---------------------------+
*   0 |      MUC_COMC_SENTH       |      MUC_COMC_SENTT       |
*     +---------------------------+---------------------------+
*   8
*
*** MUC_COM_CONFIG - Monitor User Control Block
          
*** MUC_COM_TERM - Monitor User Control Block
*
*     +---------------------------+---------------------------+
*   0 |      MUC_COMT_SENTH       |      MUC_COMT_SENTT       |
*     +------+--------------------+---------------------------+
*   8 |:_COMT|////////////////////| C
*     +------+--------------------+
*
*** MUC_COM_TERM - Monitor User Control Block

 
Symbol         Dspl Value
-------------- ---- -----
MUC$END        0095 00000098
MUC_COMC_SENTH
               0000
MUC_COMC_SENTT
               0004
MUC_COMD_LOST  000A
MUC_COMD_SENTC
               0008
MUC_COMD_SENTH
               0000
MUC_COMD_SENTT
               0004
MUC_COMT       0008
MUC_COMT_FLAG  0008 80
MUC_COMT_SENTH
               0000
MUC_COMT_SENTT
               0004
MUC_E_CONN     0014 40
MUC_E_HC       001D 80
MUC_EC_SENT    0054
MUC_EC_SENT_H  0054
MUC_EC_SENT_T  0058
MUC_ED_PEND    0040
MUC_ED_PEND_CT
               0048
MUC_ED_PEND_H  0040
MUC_ED_PEND_T  0044
MUC_ED_SENT    0034
MUC_ED_SENT_CT
               003C
MUC_ED_SENT_H  0034
MUC_ED_SENT_T  0038
MUC_EMAIL_NEXT
               002C
MUC_EMAIL_PREV
               0030
MUC_EPC_NEXT   004C
MUC_EPC_PREV   0050
MUC_ET_PEND    0064
MUC_ET_PEND_FL
               0064 80
MUC_ET_SENT    005C
MUC_ET_SENT_H  005C
MUC_ET_SENT_T  0060
MUC_EVENT      002C
MUC_EVENT_CONF
               004C
MUC_EVENT_DATA
               002C
MUC_EVENT_FLGS
               001D
MUC_EVENT_STAT
               001D
MUC_EVENT_TERM
               005C
MUC_I_MSGLIM   0018
MUC_IUCV       0016
MUC_MON_TYPE   0014
MUC_MSG_CT     0028
MUC_MSGLIM     0018
MUC_NEXT       0000
MUC_PATHID     0016
MUC_PREV       0004
MUC_PURGEF_CT  0024
MUC_QUIESCE    001E 80
MUC_QUIS       001E
MUC_QUIS_FLAGS
               001E
MUC_S_CONN     0014 80
MUC_S_HC       001C 80
MUC_SAMPLE     0068
MUC_SAMPLE_CON
               007C
MUC_SAMPLE_DAT
               0068
MUC_SAMPLE_FLG
               001C
MUC_SAMPLE_STA
               001C
MUC_SAMPLE_TER
               008C
MUC_SC_SENT    0084
MUC_SC_SENT_H  0084
MUC_SC_SENT_T  0088
MUC_SD_LOSG_BI
               007A 80
MUC_SD_LOST    007A
MUC_SD_SENT    0070
MUC_SD_SENT_CT
               0078
MUC_SD_SENT_H  0070
MUC_SD_SENT_T  0074
MUC_SESSION    0014
MUC_SEVER      0020
MUC_SEVER_FLGS
               0020
MUC_SMAIL_NEXT
               0068
MUC_SMAIL_PREV
               006C
MUC_SPC_NEXT   007C
MUC_SPC_PREV   0080
MUC_ST_PEND    0094
MUC_ST_PEND_FL
               0094 80
MUC_ST_SENT    008C
MUC_ST_SENT_H  008C
MUC_ST_SENT_T  0090
MUC_USER_STAT  001C
MUC_USERID     0008
MUC_VMDBKAD    0010
MUCSIZE        0095 00000013