LS_INDICATION

This indication is generated when the number of active sessions using the link changes, or the external state of the link station changes. Link station statistics are supplied when the link station becomes inactive.

VCB Structure

typedef struct ls_indication
{
   unsigned short  opcode;              /* verb operation code           */
   unsigned char   attributes;          /* verb attributes               */
   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   ls_name[8];          /* link station name             */
   unsigned char   description[RD_LEN]; /* resource description          */
   unsigned char   adj_cp_name[17];     /* network qualified Adj CP name */
   unsigned char   adj_node_type;       /* adjacent node type            */
   unsigned short  act_sess_count;      /* active session count on link  */
   unsigned char   indication_cause;    /* cause of indication           */
   LS_STATS        ls_stats;            /* link station statistics       */
   unsigned char   tg_num;              /* TG number                     */
   unsigned long   sense_data;          /* sense data                    */
   unsigned char   brnn_link_type;      /* branch link type              */
   unsigned char   adj_cp_is_brnn;      /* adjacent CP is a BrNN         */
   unsigned char   reserva[17];         /* reserved                      */
} LS_INDICATION;
typedef struct ls_stats
{
   unsigned long   in_xid_bytes;        /* num of XID bytes received     */
   unsigned long   in_msg_bytes;        /* num message bytes received    */
   unsigned long   in_xid_frames;       /* num XID frames received       */
   unsigned long   in_msg_frames;       /* num message frames received   */
   unsigned long   out_xid_bytes;       /* num XID bytes sent            */
   unsigned long   out_msg_bytes;       /* num message bytes sent        */
   unsigned long   out_xid_frames;      /* number of XID frames sent     */
   unsigned long   out_msg_frames;      /* num message frames sent       */
   unsigned long   in_invalid_sna_frames;
                                        /* num invalid frames recvd      */
   unsigned long   in_session_control_frames;
                                        /* number of control             */
                                        /* frames recvd                  */
   unsigned long   out_session_control_frames;
                                        /* number of control             */
                                        /* frames sent                   */
   unsigned long   echo_rsps;           /* response from adj LS count    */
   unsigned long   current_delay;       /* time taken for last           */
                                        /* test signal                   */
   unsigned long   max_delay;           /* max delay by test signal      */
   unsigned long   min_delay;           /* min delay by test signal      */
   unsigned long   max_delay_time;      /* time since longest delay      */
   unsigned long   good_xids;           /* successful XID on LS count    */
   unsigned long   bad_xids;            /* unsuccessful XID on LS count  */
} LS_STATS;

Parameters

opcode
AP_LS_INDICATION
attributes
The attributes of the verb. This field is a bit field. The first bit contains the visibility of the resource to be defined and corresponds to one of the following:

AP_EXTERNALLY_VISIBLE
AP_INTERNALLY_VISIBLE

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_YES when the LS becomes inactive. Set to AP_NO when the LS becomes active.
ls_name
Name of link station. This is an 8-byte string in a locally displayable character set. All 8 bytes are significant.
description
Resource description (as specified on DEFINE_LS). This is a 16-byte string in a locally displayable character set. All 16 bytes are significant.
adj_cp_name
Fully-qualified, 17-byte long, adjacent control point name. It 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.)
adj_node_type
Type of the node. It is one of the following values:

AP_END_NODE
AP_NETWORK_NODE
AP_LEN_NODE
AP_VRN

act_sess_count
Total number of active sessions (both endpoint and intermediate) using the link.
indication_cause
Cause of the indication. It is one of the following values:
AP_ACTIVATION_STARTED
The link is activating.
AP_ACTIVATING
The link has become active.
AP_DEACTIVATION_STARTED
The link is being deactivated.
AP_DEACTIVATING
The link has become inactive.
AP_SESS_COUNT_CHANGING
The number of active sessions using the link has changed.
AP_CP_NAME_CHANGING
An adjacent node has changed its control point name.
AP_FAILED
The link has failed.
AP_ACTIVATION_FAILED
The link failed to activate.
AP_PENDING_RETRY
A retry timer has been started. When the timer expires, activation of the link is automatically retried.
AP_DATA_LOST
A previous indication has been lost. Note that link station statistics are only supplied when the link station goes from active to inactive (that is, deactivating is set to AP_YES and indication_cause is set to AP_DEACTIVATING). In all other cases the fields are reserved.
ls_stats.in_xid_bytes
Total number of XID (Exchange Identification) bytes received on this link station.
ls_stats.in_msg_bytes
Total number of data bytes received on this link station.
ls_stats.in_xid_frames
Total number of XID (Exchange Identification) frames received on this link station.
ls_stats.in_msg_frames
Total number of data frames received on this link station.
ls_stats.out_xid_bytes
Total number of XID (Exchange Identification) bytes sent on this link station.
ls_stats.out_msg_bytes
Total number of data bytes sent on this link station.
ls_stats.out_xid_frames
Total number of XID (Exchange Identification) frames sent on this link station.
ls_stats.out_msg_frames
Total number of data frames sent on this link station.
ls_stats.in_invalid_sna_frames
Total number of SNA incorrect frames received on this link station.
ls_stats.in_session_control_frames
Total number of session control frames received on this link station.
ls_stats.out_session_control_frames
Total number of session control frames sent on this link station.
ls_stats.echo_rsps
Number of echo responses received from the adjacent node. Echo requests are sent periodically to gauge the propagation delay to the adjacent node.
ls_stats.current_delay
Time (in milliseconds) that it took for the last test signal to be sent and returned from this link station to the adjacent link station.
ls_stats.max_delay
Longest time taken (in milliseconds) for a test signal to be sent and returned from this link station to the adjacent link station.
ls_stats.min_delay
Shortest time taken (in milliseconds) for a test signal to be sent and returned from this link station to the adjacent link station.
ls_stats.max_delay_time
Time since system startup (in hundredths of a second) when the longest delay occurred.
ls_stats.good_xids
Total number of successful XID exchanges that have occurred on this link station since it was started.
ls_stats.bad_xids
Total number of unsuccessful XID exchanges that have occurred on this link station since it was started.
tg_num
Number associated with the TG.
sense_data
This sense data is set if Personal Communications or Communications Server detects an XID protocol error. This field is reserved unless indication_cause is AP_FAILED.
brnn_link_type
BrNN only. This branch link type. It is one of the following:
AP_UPLINK
This link is an uplink.
AP_DOWNLINK
The link is a downlink.
AP_OTHERLINK
This link is an otherlink.
AP_UNKNOWN_LINK_TYPE
This link is an otherlink.

Other node types: This field is not meaningful and is always set to AP_BRNN_NOT_SUPPORTED.

adj_cp_is_brnn
All node types: Specifies whether the adjacent node is a BrNN.
AP_UNKNOWN
It is not known whether the adjacent node is a BrNN.
AP_NO
The adjacent node is not a BrNN.
AP_YES
The adjacent node is BrNN.