SESSION_INDICATION

This indication is generated when a session is activated or deactivated. When a session is deactivated, final session statistics will be returned. When a session is activated, the sess_stats field is reserved.

VCB Structure

typedef struct session_indication
{
   unsigned short  opcode;               /* verb operation code           */
   unsigned char   reserv2;              /* reserved                      */
   unsigned char   format;               /* format                        */
   unsigned short  primary_rc;           /* primary return code           */
   unsigned long   secondary_rc;         /* secondary return code         */
   unsigned char   data_lost;            /* previous indication lost      */
   unsigned char   deactivated;          /* has session been deactivated? */
   unsigned char   lu_name[8];           /* LU name                       */
   unsigned char   lu_alias[8];          /* LU alias                      */
   unsigned char   plu_alias[8];         /* partner LU alias              */
   unsigned char   fqplu_name[17];       /* fully qualified partner       */
                                         /* LU name                       */
   unsigned char   mode_name[8];         /* mode name                     */
   unsigned char   session_id[8];        /* session ID                    */
   FQPCID          fqpcid;               /* fully qualified procedure     */
   unsigned long   sense_data;           /* sense_data                    */
   unsigned char   duplex_support;       /* full-duplex support           */
   SESSION_STATS   sess_stats;           /* session statistics            */
   unsigned char   sscp_id[6];           /* SSCP ID of host               */
   unsigned char   plu_slu_comp_lvl;     /* PLU to SLU compression level  */
   unsigned char   slu_plu_comp_lvl;     /* SLU to PLU compressionlevel   */
                                         /* correlator ID                 */
   unsigned char   reserva[12];          /* reserved                      */
} SESSION_INDICATION;
typedef struct fqpcid
{
   unsigned char   pcid[8];              /* procedure correlator          */
                                         /* identifier                    */
   unsigned char   fqcp_name[17];        /* originator's network          */
                                         /* qualified CP name             */
   unsigned char   reserve3[3];          /* reserved                      */
} FQPCID;
typedef struct session_stats
{
   unsigned short  rcv_ru_size;          /* session receive RU size       */
   unsigned short  send_ru_size;         /* session send RU size          */
   unsigned short  max_send_btu_size;    /* max send BTU  size            */
   unsigned short  max_rcv_btu_size;     /* max rcv BTU size              */
   unsigned short  max_send_pac_win;     /* max send pacing window size   */
   unsigned short  cur_send_pac_win;     /* curr send pacing window size  */
   unsigned short  max_rcv_pac_win;      /* max receive pacing win size   */
   unsigned short  cur_rcv_pac_win;      /* curr receive pacing win size  */
   unsigned long   send_data_frames;     /* number of data frames sent    */
   unsigned long   send_fmd_data_frames;
                                         /* num FMD data frames sent      */
   unsigned long   send_data_bytes;      /* number of data bytes sent     */
   unsigned long   rcv_data_frames;      /* num data frames received      */
   unsigned long   rcv_fmd_data_frames;
                                         /* num FMD data frames received  */
   unsigned long   rcv_data_bytes;       /* num data bytes received       */
   unsigned char   sidh;                 /* session ID high byte          */
   unsigned char   sidl;                 /* session ID low byte           */
   unsigned char   odai;                 /* ODAI bit set                  */
   unsigned char   ls_name[8];           /* Link station name             */
   unsigned char   pacing_type;          /* type of pacing in use         */
   unsigned char   reserve;              /* reserved                      */
} SESSION_STATS;

Parameters

opcode
AP_SESSION_INDICATION
format
Identifies the format of the VCB. This field is set to zero to specify the version of the VCB listed above.
primary_rc
AP_OK
secondary_rc
Equals zero.
data_lost
Specifies whether data has been lost (AP_YES or AP_NO). It is set when an internal component detects a failure that has caused a previous indication to be lost. If the data_lost flag is set to AP_YES then subsequent data fields can be set to null. The application should issue a QUERY verb to update the information that has been lost.
deactivated
Set to AP_NO when a session is activated. Set to AP_YES when a session is deactivated.
lu_name
LU name. This name is an 8-byte type-A EBCDIC character string.
lu_alias
Locally defined LU alias. This is an 8-byte string in a locally displayable character set. All 8 bytes are significant.
plu_alias
Partner LU alias. This is an 8-byte string in a locally displayable character set.
fqplu_name
17-byte fully qualified network name for the partner LU. This name is composed of two type-A EBCDIC character strings concatenated by an EBCDIC dot, and is right-padded with EBCDIC spaces. (Each name can have a maximum length of 8 bytes with no embedded spaces.)
mode_name
Mode name, which designates the network properties for a group of sessions. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces.
session_id
8-byte identifier of the session.
fqpcid.pcid
Procedure correlator ID. This is an 8-byte hexadecimal string.
fqpcid.fqcp_name
Fully qualified control point name. This name is 17 bytes long and is right-padded with EBCDIC spaces. It is composed of two type-A EBCDIC character strings concatenated by an EBCDIC dot. (Each name can have a maximum length of 8 bytes with no embedded spaces.)
sense_data
The sense data sent or received on the UNBIND request. This field is reserved if deactivated is AP_NO.
duplex_support
Returns the conversation duplex support as negotiated on the BIND. This is one of the following values:
AP_HALF_DUPLEX
Only half-duplex conversations are supported.
AP_FULL_DUPLEX
Full-duplex as well as half-duplex conversations are supported.
AP_UNKNOWN
The conversation duplex support is not known because there are no active sessions to the partner LU.
sess_stats.rcv_ru_size
Maximum receive RU size.
sess_stats.send_ru_size
Maximum send RU size.
sess_stats.max_send_btu_size
Maximum BTU size that can be sent.
sess_stats.max_rcv_btu_size
Maximum BTU size that can be received.
sess_stats.max_send_pac_win
Maximum size of the send pacing window on this session.
sess_stats.cur_send_pac_win
Current size of the send pacing window on this session.
sess_stats.max_rcv_pac_win
Maximum size of the receive pacing window on this session.
sess_stats.cur_rcv_pac_win
Current size of the receive pacing window on this session.
sess_stats.send_data_frames
Number of normal flow data frames sent.
sess_stats.send_fmd_data_frames
Number of normal flow FMD data frames sent.
sess_stats.send_data_bytes
Number of normal flow data bytes sent.
sess_stats.rcv_data_frames
Number of normal flow data frames received.
sess_stats.rcv_fmd_data_frames
Number of normal flow FMD data frames received.
sess_stats.rcv_data_bytes
Number of normal flow data bytes received.
sess_stats.sidh
Session ID high byte.
sess_stats.sidl
Session ID low byte.
sess_stats.odai
Origin destination address indicator. When bringing up a session, the sender of the BIND sets this field to zero if the local node contains the primary link station, and sets it to 1 if the BIND sender is the node containing the secondary link station.
sess_stats.ls_name
Link station name associated with statistics. This is an 8-byte string in a locally displayable character set. All 8 bytes are significant. This field can be used to correlate the session statistics with the link over which session traffic flows.
sess_stats.pacing_type
Receive pacing type in use on this session. This can take the values AP_NONE, AP_PACING_ADAPTVE or AP_PACING_FIXED.
sscp_id
For dependent LU sessions, this field contains the SSCP ID received in the ACTPU from the host for the PU that the local LU is mapped to. For independent LU sessions, this field will be set to all binary zeros.
plu_slu_comp_lvl
Specifies the compression level for data sent from the PLU to the SLU.
AP_NONE
Compression is not used.
AP_RLE_COMPRESSION
RLE compression is used.
AP_LZ9_COMPRESSION
This node can support LZ9 compression.
AP_LZ10_COMPRESSION
The node can support LZ10 compression.
AP_LZ12_COMPRESSION
The node can support LZ12 compression.
slu_plu_comp_lvl
Specifies the compression level for data sent from the SLU to the PLU.
AP_NONE
Compression is not used.
AP_RLE_COMPRESSION
RLE compression is used.
AP_LZ9_COMPRESSION
This node can support LZ9 compression.
AP_LZ10_COMPRESSION
The node can support LZ10 compression.
AP_LZ12_COMPRESSION
The node can support LZ12 compression.