Synopsis

Sets the filter object on the subscriber's callback object.

OMG IDL

add_filter(
      in Filter new_filter
);

Exceptions

Description

Used when subscribing. This operation is used in subscriber applications to set the filter object to the subscriber's callback object. If the application using this operation will be shut down and restarted, the filter_id should be written to persistent storage.

Note: This operation: (1) cannot be called after the subscriber callback object is connected (see connect_structured_push_consumer above), (2) cannot be called more than once, and (3) when it is called, the filter constraint expression must already be present in the filter (see CosNotifyFilter::Filter add_constraints).

Note: Only filters created by the event channel's default filter factory can be added.

Return Value

Returns a filter_id.

Examples

C++ code example:

CosNotifyFilter::FilterID filter_id =
      subscription->add_filter(filter.in());

Java code example: