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

Overview
HP-UX IPQoS API Overview
Chapter 116
HP-UX IPQoS API Overview
This section describes general overview information for using the HP-UX IPQoS API.
Subsequent chapters in this guide provide more detailed usage information.
Programmatic Requirements
To use the HP-UX IPQoS API, the application needs to:
• have super-user (root) privileges
• include the header file: #include <netinet/ipqos.h>
• link to the shared library libipqos.sl
IMPORTANT HP-UX IPQoS supplies only the 32-bit version of the shared library. Thus,
applications must be 32-bit.
IMPORTANT To use the HP-UX IPQoS API, HP-UX IPQoS must be in one of the ENABLED
states (refer to the HP-UX IPQoS A.01.00 Administrator’s Guide for more
information on HP-UX IPQoS states of operation).
Structural Overview (How to Use the HP-UX IPQoS API)
The HP-UX IPQoS API is based on the usage of objects, lists and sessions.
Objects: Objects are pointers to opaque structures. There are three object types: filters,
policies and adapters (IpqosFilter, IpqosPolicy, IpqosAdapter respectively). Filter objects
and policy objects can be constructed (created, destroyed, attached, deleted and copied) by the
programmer. The list of adapter objects is a fixed list that is built by the HP-UX IPQoS API
during session initialization. Thus, adapter objects cannot be constructed by the programmer.
All three types of objects have attributes that can be accessed (by using “get” type functions).
Filter objects and policy objects can also be modified (using “set” type functions).
Lists: When policy or filter objects are part of an active configuration, they exist in a list. Each
adapter object has an attached policy list and each policy object has an attached filter list.
Adapter, policy and filter lists can be traversed by the programmer.