CORBA IDL

SubscriptionID subscribe (
      in    string                             subscription_name,
      in    RegularExpression                  domain,
      in    RegularExpression                  type,
      in    FilterExpression                   data_filter,
      // The filter expression must length 1 and the name must
      // be TRANSIENT_SUBSCRIPTION or PERSISTENT_SUBSCRIPTION.
      in    CosNotification::QoSProperties     qos,
      in    CosNotifyComm::StructuredPushConsumer push_consumer
);

Parameters

Exceptions

Description

Use this operation to subscribe to events. This operation is called by a subscriber application on the Notification Service to create a subscription to a particular event. The subscription name, domain name, type name, data filter, quality of service, and the object reference of the subscriber's callback object are passed in. The callback object implements the CosNotifyComm::StructuredPushConsumer IDL interface.

Note: For subscribers that shut down and restart, you must write the subscription_id to persistent storage.

Return Value

Note: Notification Service applications that start and shut down only once can use the subscription_id to determine if their subscription has been cancelled automatically or by the system administrator.

Examples

C++ code example:

subscription_id = channel->subscribe(
          subscription_name,
          "News", // domain
          "Sports",   // type
          "",     // No data filter.
          qos,
          news_consumer.in()
        );

Java code example: