Overview
HP-UX IPQoS API Overview
Sessions: Every application that uses the HP-UX IPQoS API must start a session. The function used to start a session is IpqosInitSession(). One of the arguments of this function specifies a session type. There are three types of sessions: IPQOS_SESSION_CONFIG (used for active “set” functions), IPQOS_SESSION_READ (used for passive ”get” functions) and IPQOS_SESSION_STATS (used for functions related to obtaining and resetting statistics). Sessions must be terminated. There are two ways of terminating a session: committing (saving) or aborting (quitting without saving), using IpqosCommitSession() and IpqosAbortSession(), respectively.
See the relevant sections of Chapter 2, “Using the HP-UX IPQoS API,” on page 21, for more information on how the HP-UX IPQoS API uses objects, lists and sessions.
NOTE | The data structures used in HP-UX IPQoS are opaque and need not be an |
| explicit concern of programmers using the API. |
| |
Functional Overview (What You Can Do Using the HP-UX IPQoS API)
There are several types of tasks you can accomplish using the HP-UX IPQoS API functions. There are also several possible ways to group these tasks. The list below groups the tasks in a way that serves the purpose of describing the tasks from a high-level perspective. For example, some common tasks that can be performed on filter and policy objects are discussed together in this guide, to minimize redundancy.
NOTE | The HP-UX IPQoS API manpages group the functions slightly differently, |
| which is appropriate since the purpose of the manpages is to provide detailed |
| reference information. The groupings used in the manpages work best for |
| detailed syntactical descriptions where redundancy is not a concern. |
| |
The following list provides broad groups of functional tasks that can be accomplished using the HP-UX IPQoS API. For each grouping, the text indicates where more information can be found in this guide, as well as the relevant manpages to refer to for more information.
•Session Management: Initiating and Terminating Sessions.
-In this guide: See “Using Sessions” on page 22, for more information.
-Relevant manpage: IpqosSession (3c)
•Resource Management: Creating/Destroying/Copying (Filter and Policy) Objects
-In this guide: See “Using Objects” on page 25, for more information.
-Relevant manpages: IpqosFilter (3c), IpqosPolicy (3c)