Registered Filter APIs
A filter is a function that you can use to assign events into groups and to specify actions to take for each group. The registered filter APIs allow a product to register a filter with the operating system. The product can receive notification of events recorded in a data queue by using the Send to Data Queue (SNDDTAQ) action of the Work with Filter Action Entry (WRKFTRACNE) command.
A user filter is the filter defined by the network attributes for alert filtering and by the system value for problem log filtering. A user filter and a registered filter differ in their function and their notification record. There can only be one user filter active at one time for each type of filter, but there can be multiple registered filters active at one time. All actions are active for a user filter, but only the SNDDTAQ action is active for a registered filter.
A product can use registered filter APIs for the following purposes:
- To register multiple filters at the same time for each event type (alert or problem log)
- To deregister a filter when notifications from that filter are no longer necessary
- To retrieve all the filters that are registered
The event notification record for a registered filter differs from notification records for other types of filters. The registered notification contains a common header for all events, as well as specific information based on the type of event. The common header includes the name of the notification, a function type, a format, the filter name and library, the group name, and a timestamp. The specific information for the problem log includes the problem ID, the last event logged, and the timestamp for the last event.
The registered filter APIs are:
- Deregister Filter Notifications (QNMDRGFN) deregisters a filter. If the identified filter is not currently registered, an error is returned.
- Register Filter Notifications (QNMRGFN) registers a filter to send notifications for a specific event to a data queue.
- Retrieve Registered Filters (QNMRRGF) returns all filters registered for a filter type.
[ Back to top | Network Management APIs | APIs by category ]