CORBA Notification Service API Reference

Using the CORBA Notification Service

CosNotifyChannelAdmin::StructuredProxyPushSupplier::get_filter

Synopsis

Gets an object reference to the filter currently associated with the subscriber's callback object.

OMG IDL

Filter get_filter( in FilterID filter )
      raises ( FilterNotFound);

Exceptions

CosNotifyChannelAdmin::FilterNotFound

The filter could not be found.

Description

Used when a restartable subscriber wants to unsubscribe. This operation is used in subscriber applications to get an object reference to the filter currently associated with the subscriber's callback object. The FilterID that is passed in must be valid for the subscriber's StructuredProxyPushSupplier object. If the FilterID is not valid for any proxy object associated with the event channel, then a FilterNotFound exception is thrown. The operation is only used by subscribers that shut down and restart.

Restrictions

The following usage restrictions and guidelines apply to this operation:

Filter object references that are returned from this operation cannot be used in comparison operations.

Filter object references returned by this operation can be used by the CosNotifyFilter::Filter::destroy operations but are of little use since they cannot be modified or added to proxy objects.

Return Value

Returns a filter object reference to the filter currently associated with the subscriber's callback object.

Examples

C++ code example:

CosNotify::Filter_var filter = 
     subscription->get_filter( filter_id() );