HP-UX IPQoS A.01.00 Programmer's Guide (October 2005)

Overview
HP-UX IPQoS API Overview
Chapter 1 19
• IpqosAPI (3c): Provides an overview of the HP-UX IPQoS API. It describes the types of
tasks programmers can perform with the API. It explains how sessions are used and
introduces the HP-UX IPQoS API object classes (IpqosFilter, IpqosPolicy,
IpqosAdapter).
• IpqosSession (3c): Provides information on functions related to HP-UX IPQoS session
management. This includes details on: initiating sessions, committing sessions and
aborting sessions. It also discusses the three session types available.
• IpqosAdapter (3c): Provides information on functions related to HP-UX IPQOS adapters,
including: obtaining information about adapters, traversing the list of HP-UX IPQoS
adapters, and traversing the list of policies associated with adapters. It also includes
relevant session-related information.
• IpqosPolicy (3c): Provides information on functions related to HP-UX IPQoS policies,
including: creating policies, assigning and accessing values of policy attributes,
associating policies with adapters, and traversing the filter lists of the polices. It also
includes relevant session-related information.
• IpqosFilter (3c): Provides information on functions related to HP-UX IPQoS filters,
including: creating filters, assigning and accessing values of filter attributes, and
associating filters with policies. It also includes relevant session-related information.
• IpqosOverlapFilter (3c): Provides information on functions related to checking HP-UX
IPQoS filters for overlap conditions.
• IpqosStats (3c): Provides information on functions related to obtaining (and resetting)
statistics on the filters and policies of the HP-UX IPQoS configuration.
Return Codes
Most functions in the HP-UX IPQoS API return a uint32_t value that represents the return
code of the function call. When successful, the return code will be the symbolic constant
IPQOS_S_SUCCESS.
In some cases, other values will be returned, which may or may not indicate a failure. For
example, the list traversal routines may return the value IPQOS_S_LIST_EMPTY. You may
receive this value if you are trying to set the traversal to the head of the list, and the list is
empty. Or, you may receive this value if you are trying to traverse to the next item in the list
and there are no more items in the list.
In general, for “get” functions: A return of IPQOS_E_ATTRIBUTE_NOT_SET signifies that the
attribute is not set for the object. A return of IPQOS_S_SUCCESS signifies the attribute is set.
Any other return code is an error.
In general, for “set” functions: A return of any value other than IPQOS_S_SUCCESS signifies an
error.