bbFilters(2K)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES

NAME

bbFilters- gets or sets or gets and sets the filter list and the filtered severity bitmap

SYNOPSIS

#include <blackbox/chBlackBox.h>

int bbFilters(KnBBFilter *oldflt, int* out, KnBBFilter *newflt, int in);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

bbFilters() gets or sets or gets and sets the filter list and the filtered severity bitmap for the node.

If oldflt is not the NULL pointer, the filtered severity bitmap will be copied to the location pointed to by oldflt.

If newflt is not the NULL pointer, the filtered severity bitmap will be set to the value of the bitmaps pointed to by newflt.

The argument oldflt is an array of out KnBBFilters

The argument out is the number of KnBBFilters passed in oldflt

The argument newflt is an array of in KnBBFilters

The argument in is the number of KnBBFilters passed in newflt

The members of the KnBBFilter structure are:

bbf_severity

minimum severity to pass the filter

bbf_tag

string to match to pass the filter

The bbf_tag member is a string of maximum length BB_TAG_MAX characters (including the trailing /0).

The bbf_severity member is a bitmap of severity levels between 0 and 31 inclusive. A given severity level can be tested for or modified with the BB_SEV_* interfaces.

If the bbf_tag member of a returned KnBBFilter matches the reserved tag BB_ALL_TAGS, the bbf_severity member is the filtered severity bitmap for the system.

When calling bbFilters(), out should point to the number of KnBBFilters passed in oldflt. On successful return, out will be updated with the total number of filters on the system, including 1 for the filtered severity bitmap (if it exists).

The caller can determine the number of filters on the node by passing a NULL filters value and a valid out pointer, e.g. the address of an integer with value 0.

The filter list passed in newflt does not add to or modify the current filter list or filtered severity bitmap; it replaces them entirely. If multiple conflicting filters are passed in in a single array, the filter with higher array index will take precedence.

Calling bbFilters(NULL, NULL, NULL, 0) resets the list of Filters.

RETURN VALUES

bbFilters() returns K_OK on success, otherwise a negative error code is returned.

ERRORS

[K_ENOMEM]:

No room to allocate new filters

[K_EFAULT]:

Some of the arguments provided are outside the caller's address space.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES