org.omg.CosTypedNotifyChannelAdmin
Interface TypedProxyPullConsumerOperations

All Superinterfaces:

FilterAdminOperations, NotifyPublishOperations, ProxyConsumerOperations, PullConsumerOperations, QoSAdminOperations

All Known Subinterfaces:

TypedProxyPullConsumer

public interface TypedProxyPullConsumerOperations
extends ProxyConsumerOperations, PullConsumerOperations

The TypedProxyPullConsumer interface supports connections to the channel by suppliers who will make OMG Event Service style typed events available for pulling to the channel.

Through inheritance of the ProxyConsumer interface, the ProxyPullConsumer interface supports administration of various QoS properties, administration of a list of associated filter objects, and a readonly attribute containing the object reference of the SupplierAdmin3 instance, which created a given TypedProxyPullConsumer instance. In addition, this inheritance implies that a TypedProxyPullConsumer instance supports an operation that will return the list of event types, which consumers connected to the same channel are interested in receiving, and an operation that can return information about the instance?s ability to accept a per-event QoS request.

The TypedProxyPullConsumer interface also inherits from the PullConsumer interface defined within the CosNotifyComm module. This interface supports the operation required to disconnect the TypedProxyPullConsumer from its associated supplier. In addition, since the inherited PullConsumer interface inherits the CosNotifyComm::NotifyPublish interface, a supplier connected to an instance supporting the TypedProxyPullConsumer interface can inform it whenever the list of event types the supplier plans to supply changes.

Finally, the TypedProxyPullConsumer interface defines the operation that can be invoked by a typed pull supplier to establish the connection over which the typed pull supplier will send events to the channel. Note that this can be either a pure event service style, or a notification service style typed pull supplier. The TypedProxyPullConsumer interface also defines a pair of operations, which can suspend and resume the connection between a TypedProxyPullConsumer instance and its associated TypedPullSupplier. During the time such a connection is suspended, the TypedProxyPullConsumer will not attempt to pull events from its associated TypedPullSupplier.

Method Summary

void	connect_typed_pull_supplier(org.omg.CosTypedEventComm.TypedPullSupplier pull_supplier) This operation is invoked in order to establish a connection between a pull-style supplier of typed events, and the notification channel.
void	resume_connection() The resume_connection operation causes the target object supporting the TypedProxyPullConsumer interface to resume attempting to pull events (using pull or try_pull) from the TypedPullSupplier instance connected to it.
void	suspend_connection() The suspend_connection operation causes the target object supporting the TypedProxyPullConsumer interface to stop attempting to pull events (using pull or try_pull) from the TypedPullSupplier instance connected to it.

Methods inherited from interface org.omg.CosNotifyChannelAdmin.ProxyConsumerOperations

MyAdmin, MyType, obtain_subscription_types, 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.NotifyPublishOperations

offer_change

Methods inherited from interface org.omg.CosEventComm.PullConsumerOperations

disconnect_pull_consumer

Method Detail

resume_connection

void resume_connection()
                       throws ConnectionAlreadyActive,
                              NotConnected

The resume_connection operation causes the target object supporting the TypedProxyPullConsumer interface to resume attempting to pull events (using pull or try_pull) from the TypedPullSupplier instance connected to it. This operation takes no input parameters and returns no values. After this method is called, this TypedProxyPullConsumer will resume attempting to pull events from the TypePullSupplier connected to it.

Throws:

ConnectionAlreadyActive - If the connection has not been previously suspended using this operation by invoking suspend_connection.

NotConnected - If no TypedPullSupplier has been connected to the target object when this operation is invoked.

suspend_connection

void suspend_connection()
                        throws ConnectionAlreadyInactive,
                               NotConnected

The suspend_connection operation causes the target object supporting the TypedProxyPullConsumer interface to stop attempting to pull events (using pull or try_pull) from the TypedPullSupplier instance connected to it. After this method is called, this TypedProxyPullConsumer does not attempt to pull events from the TypedPullSupplier connected to it until resume_connection is subsequently invoked. This operation takes no input parameters and returns no values.

Throws:

ConnectionAlreadyInactive - If the connection has been previously suspended using this operation and not resumed by invoking resume_connection.

NotConnected - If no TypedPullSupplier has been connected to the target object when this operation is invoked.

connect_typed_pull_supplier

void connect_typed_pull_supplier(org.omg.CosTypedEventComm.TypedPullSupplier pull_supplier)
                                 throws AlreadyConnected,
                                        TypeError

This operation is invoked in order to establish a connection between a pull-style supplier of typed events, and the notification channel. Once established, the channel can proceed to receive events from the supplier by invoking the event type specific operation(s) supported by the supplier.

Note that because the TypedPullSupplier interface defined in the CosTypedNotifyComm module inherits from the TypedPullSupplier interface defined in the CosTypedEventComm module, the input parameter to this operation could be either a pure event service style, or a notification service style typed pull supplier. The only difference between the two are that the latter also supports the NotifySubscribe interface, and thus can be the target of subscription_change invocations. The implementation of the TypedProxyPullConsumer interface should attempt to narrow the input parameter to CosTypedNotifyComm::TypedPullSupplier in order to determine which style of typed pull supplier is connecting to it.

Parameters:

pull_supplier - The reference to an object supporting the TypedPullSupplier interface defined within the CosTypedEventComm module. This reference is that of a supplier that plans to make OMG Event Service style typed events available for pulling to the channel with which the target object is associated.

Throws:

AlreadyConnected - If the target object of this operation is already connected to a typed pull supplier object.

TypeError - If the typed pull supplier being connected does not meet additional requirements, this instance imposes on the interface supported by the typed pull supplier (e.g., it may be designed to invoke some specific pull-style operation to receive events).