HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs

APING

AP_INVALID_MESSAGE_TYPE

The message_type parameter speciﬁed a value that was not valid.

INVALID_RTP_CONNECTION

The resource_name parameter does not match any RTP connection.

Appendix B, Common Return Codes lists further secondary return codes associated with

AP_PARAMETER_CHECK,

which are common to all NOF verbs.

3.3.5 Returned Parameters: Other Conditions

Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are

common to all NOF verbs.

3.4 APING

APING is the APPN version of the “ping” utility; it allows a management application to check the communications

path from a local LU to a remote LU in the network.

SNAplus2 APING is implemented using an internally-deﬁned APPC TP. This TP sends data to the partner LU, and

optionally receives data from the partner LU. If the TP completes successfully, the APING verb returns information

about the time taken to allocate a conversation to the partner LU and to send and receive data.

The application must supply a VCB that is large enough to include a partner TP veriﬁcation string of the requested

size as well as the basic APING VCB structure; the returned data includes this string appended to the end of the

basic structure.

This verb is intended for checking the path to an LU on a remote node. Using APING to check communications

with a partner LU on the local node will impact the performance of other programs on the local computer, and is

not recommended.

This verb must be issued to a running node.

3.4.1 VCB Structure

typedef struct aping

{

AP_UINT16 opcode; /* verb operation code */

unsigned char reserv2; /* reserved */

unsigned char format; /* reserved */

AP_UINT16 primary_rc; /* primary return code */

AP_UINT32 secondary_rc; /* secondary return code */

unsigned char lu_name[8]; /* local LU name */

unsigned char lu_alias[8]; /* local LU alias */

AP_UINT32 sense_data; /* sense data */

unsigned char plu_alias[8]; /* partner LU alias */

unsigned char mode_name[8]; /* mode name */

unsigned char tp_name[64]; /* destination TP name */

unsigned char security; /* security level */

unsigned char reserv3a[3]; /* reserved */

unsigned char pwd[10]; /* password */

unsigned char user_id[10]; /* user ID */

AP_UINT16 dlen; /* length of data to send */

AP_UINT16 consec; /* number of consecutive sends */

unsigned char fqplu_name[17]; /* fully qualified partner LU name */