org.omg.CosNotifyChannelAdmin
Interface StructuredProxyPullSupplierOperations

All Superinterfaces:

FilterAdminOperations, NotifySubscribeOperations, ProxySupplierOperations, QoSAdminOperations, StructuredPullSupplierOperations

All Known Subinterfaces:

StructuredProxyPullSupplier

public interface StructuredProxyPullSupplierOperations
extends ProxySupplierOperations, StructuredPullSupplierOperations

The StructuredProxyPullSupplier interface supports connections to the channel by consumers who will pull events from the channel as Structured Events. Through inheritance of the ProxySupplier interface, the StructuredProxyPullSupplier interface supports administration of various QoS properties, administration of a list of associated filter objects, and a readonly attribute containing the reference of the ConsumerAdmin object that created it. In addition, this inheritance implies that a StructuredProxyPullSupplier instance supports an operation that will return the list of event types, which the proxy supplier will potentially by supplying, and an operation which can return information about the instance?s ability to accept a perevent QoS request.

The StructuredProxyPullSupplier interface also inherits from the StructuredPullSupplier interface defined in the CosNotifyComm module. This interface supports the operations that enable a consumer of Structured Events to pull them from the StructuredProxyPullSupplier, and also the operation that can be invoked to close down the connection from the consumer to the StructuredProxyPullSupplier. In addition, since the StructuredPullSupplier interface inherits from the NotifySubscribe interface, a StructuredProxyPullSupplier can be notified whenever the list of event types, which its associated consumer is interested in receiving changes.

Lastly, the StructuredProxyPullSupplier interface defines a method that can be invoked by a pull-style consumer of Structured Events in order to establish a connection between the consumer and a notification channel over which the consumer will proceed to receive events.

Method Summary

void	connect_structured_pull_consumer(StructuredPullConsumer pull_consumer) This operation is invoked in order to establish a connection between a pull-style consumer of events in the form of Structured Events, and the notification channel.

Methods inherited from interface org.omg.CosNotifyChannelAdmin.ProxySupplierOperations

lifetime_filter, lifetime_filter, MyAdmin, MyType, obtain_offered_types, priority_filter, priority_filter, validate_event_qos

Methods inherited from interface org.omg.CosNotification.QoSAdminOperations

get_qos, set_qos, validate_qos

Methods inherited from interface org.omg.CosNotifyFilter.FilterAdminOperations

add_filter, get_all_filters, get_filter, remove_all_filters, remove_filter

Methods inherited from interface org.omg.CosNotifyComm.StructuredPullSupplierOperations

disconnect_structured_pull_supplier, pull_structured_event, try_pull_structured_event

Methods inherited from interface org.omg.CosNotifyComm.NotifySubscribeOperations

subscription_change

Method Detail

connect_structured_pull_consumer

void connect_structured_pull_consumer(StructuredPullConsumer pull_consumer)
                                      throws AlreadyConnected

This operation is invoked in order to establish a connection between a pull-style consumer of events in the form of Structured Events, and the notification channel. Once established, the consumer can proceed to receive events from the channel by invoking the pull_structured_event or try_pull_structured_event operations supported by the target StructuredProxyPullSupplier instance.

Parameters:

pull_consumer - The reference to an object supporting the StructuredPullConsumer interface defined within the CosNotifyComm module. This reference is that of a consumer that plans to pull events from the channel to which the target object is associated in the form of Structured Events.

Throws:

AlreadyConnected - If the target object of this operation is already connected to a pull consumer object, the AlreadyConnected exception will be raised.