User's Guide
Reference Manual
Release Notes
PDF
Top

cosNotification
Reference Manual
Version 1.1.20

Expand All
Contract All

Table of Contents

# CosNotifyFilter_FilterAdmin

### MODULE

CosNotifyFilter_FilterAdmin

### MODULE SUMMARY

This module implements the OMG CosNotifyFilter::FilterAdmin interface.

### DESCRIPTION

To get access to the record definitions for the structures use:
-include_lib("cosNotification/include/*.hrl").

All objects, which inherit this interface, export functions described in this module.

### EXPORTS

add_filter(Object, Filter) -> FilterID

Types:

Object = #objref
Filter = #objref
FilterID = long()

This operation connects a new Filter to the target object. This Filter will, together with other associated Filters, be used to select events to forward. A unique Id is returned and should be used if we no longer want to consult the given Filter.

remove_filter(Object, FilterID) -> ok

Types:

Object = #objref
FilterID = long()

If a certain Filter no longer should be associated with the target object this operation must be used. Events will no longer be tested against the Filter associated with the given Id.

get_filter(Object, FilterID) -> Reply

Types:

Object = #objref
FilterID = long()
Reply = Filter | {'EXCEPTION', #'CosNotifyFilter_FilterNotFound'{}}
Filter = #objref

If the target object is associated with a Filter matching the given Id the reference will be returned. If no such Filter is known by the target object an exception is raised.

get_all_filters(Object) -> FilterIDSeq

Types:

Object = #objref
FilterIDSeq = [FilterID]
FilterID = long()

Id's for all Filter objects associated with the target object is returned by this operation.

remove_all_filters(Object) -> ok

Types:

Object = #objref

If we want to remove all Filters associated with the target object we can use this function.