HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_NN_TOPOLOGY_TG
Number associated with the TG.
frsn
Flow Reduction Sequence Number (FRSN). Specify zero to return information about all TGs, or a nonzero
value to return information about TGs with a FRSN greater than or equal to this value.
This parameter can be used to ensure that consistent information is obtained when the application needs to
issue several verbs to obtain all the information. The application should take the following steps:
To Obtain Consistent Information Using the frsn Parameter
1. Issue QUERY_NODE to get the node’s current FRSN.
2. Issue as many QUERY_NN_TOPOLOGY_TG verbs as necessary to get all the database entries, with the
frsn parameter set to zero.
3. Issue QUERY_NODE again and compare the new FRSN with the one returned in step 1.
4. If the two FRSNs are different, the database has changed. Add
1 to the FRSN obtained in step 1, and
issue further QUERY_NN_TOPOLOGY_TG verbs with the frsn parameter set to this new value. These
verbs will return only the entries that have changed.
3.143.3 Returned Parameters: Successful Execution
If the verb executes successfully, SNAplus2 returns the following parameters:
primary_rc
AP_OK
buf_size
Length of the information returned in the supplied buffer.
total_buf_size
Returned value indicating the size of buffer that would have been required to return all the list information
requested. A value greater than buf_size indicates that not all the available entries were returned.
num_entries
Number of entries returned in the data buffer.
total_num_entries
Total number of entries available. A value greater than num_entries indicates that not all the available entries
were returned.
Each entry in the data buffer consists of the following parameters:
topology_tg_summary.overlay_size
The size of the returned
topology_tg_summary structure, and therefore the offset to the start of the next entry
in the data buffer.
When your application needs to go through the returned buffer to find each
topology_tg_summary structure in
turn, it must use this value to move to the correct offset for the next data structure, and must not use the
C sizeof() operator. This is because the size of the returned overlay may increase in future releases of
SNAplus2; using the returned overlay size ensures that your application will continue to work with future
releases.
topology_tg_summary.owner
Name of the node that owns the TG. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC
spaces. It consists of a network ID of 1–8 A-string characters, an EBCDIC dot (period) character, and a
network name of 1–8 A-string characters.
572