org.omg.CosNotifyChannelAdmin
Interface StructuredProxyPushConsumerOperations

All Superinterfaces:

FilterAdminOperations, NotifyPublishOperations, ProxyConsumerOperations, QoSAdminOperations, StructuredPushConsumerOperations

All Known Subinterfaces:

StructuredProxyPushConsumer

public interface StructuredProxyPushConsumerOperations
extends ProxyConsumerOperations, StructuredPushConsumerOperations

The StructuredProxyPushConsumer interface supports connections to the channel by suppliers who will push events to the channel as Structured Events. Through inheritance of the ProxyConsumer interface, the StructuredProxyPushConsumer interface supports administration of various QoS properties, administration of a list of associated filter objects, and a readonly attribute containing the reference of the SupplierAdmin object which created it. In addition, this inheritance implies that a StructuredProxyPushConsumer instance supports an operation which will return the list of event types which consumers connected to the same channel are interested in receiving, and an operation which can return information about the instance?s ability to accept a per-event QoS request.

The StructuredProxyPushConsumer interface also inherits from the StructuredPushConsumer interface defined in the CosNotifyComm module. This interface supports the operation that enables a supplier of Structured Events to push them to the StructuredProxyPushConumer, and also the operation that can be invoked to close down the connection from the supplier to the StructuredProxyPushConsumer. In addition, since the StructuredPushConsumer interface inherits from the NotifyPublish interface, a supplier can inform the StructuredProxyPushConsumer to which it is connected whenever the list of event types it plans to supply to the channel changes.

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

Method Summary

void	connect_structured_push_supplier(StructuredPushSupplier push_supplier) This operation is invoked in order to establish a connection between a push-style supplier of events in the form of Structured Events, and the notification channel.

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.StructuredPushConsumerOperations

disconnect_structured_push_consumer, push_structured_event

Methods inherited from interface org.omg.CosNotifyComm.NotifyPublishOperations

offer_change

Method Detail

connect_structured_push_supplier

void connect_structured_push_supplier(StructuredPushSupplier push_supplier)
                                      throws AlreadyConnected

This operation is invoked in order to establish a connection between a push-style supplier of events in the form of Structured Events, and the notification channel. Once established, the supplier can proceed to send events to the channel by invoking the push_structured_event operation supported by the target StructuredProxyPushConsumer instance.

Parameters:

push_supplier - The reference to an object supporting the StructuredPushSupplier interface defined within the CosNotifyComm module. This reference is that of a supplier which plans to push events to the channel with 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 push supplier object.