org.omg.CosNotifyChannelAdmin
Interface StructuredProxyPushSupplierOperations

All Superinterfaces:

FilterAdminOperations, NotifySubscribeOperations, ProxySupplierOperations, QoSAdminOperations, StructuredPushSupplierOperations

All Known Subinterfaces:

StructuredProxyPushSupplier

public interface StructuredProxyPushSupplierOperations
extends ProxySupplierOperations, StructuredPushSupplierOperations

The StructuredProxyPushSupplier interface supports connections to the channel by consumers who will receive events from the channel as Structured Events. Through inheritance of the ProxySupplier interface, the StructuredProxyPushSupplier 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 which created it. In addition, this inheritance implies that a StructuredProxyPushSupplier instance supports an operation which will return the list of event types, which the proxy supplier will potentially be supplying, and an operation which can return information about the instance?s ability to accept a perevent QoS request.

The StructuredProxyPushSupplier interface also inherits from the StructuredPushSupplier interface defined in the CosNotifyComm module. This interface supports the operation that can be invoked to close down the connection from the consumer to the StructuredProxyPushSupplier. In addition, since the StructuredPushSupplier interface inherits from the NotifySubscribe interface, a StructuredProxyPushSupplier can be notified whenever the list of event types, which its associated consumer is interested in receiving changes.

Lastly, the StructuredProxyPushSupplier interface defines the operation that can be invoked by a push consumer to establish the connection over which the push consumer will receive events from the channel. The StructuredProxyPushSupplier interface also defines a pair of operations that can suspend and resume the connection between a StructuredProxyPushSupplier instance and its associated StructuredPushConsumer. During the time such a connection is suspended, the StructuredProxyPushSupplier will accumulate events destined for the consumer but not transmit them until the connection is resumed.

Method Summary

void	connect_structured_push_consumer(StructuredPushConsumer push_consumer) This operation is thus invoked in order to establish a connection between a push-style consumer of events in the form of Structured Events, and the notification channel.
void	resume_connection() The resume_connection operation causes the target object supporting the StructuredProxyPushSupplier interface to resume sending events to the StructuredPushConsumer instance connected to it.
void	suspend_connection() The suspend_connection operation causes the target object supporting the StructuredProxyPushSupplier interface to stop sending events to the StructuredPushConsumer instance connected to it.

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

disconnect_structured_push_supplier

Methods inherited from interface org.omg.CosNotifyComm.NotifySubscribeOperations

subscription_change

Method Detail

resume_connection

void resume_connection()
                       throws ConnectionAlreadyActive,
                              NotConnected

The resume_connection operation causes the target object supporting the StructuredProxyPushSupplier interface to resume sending events to the StructuredPushConsumer instance connected to it. This operation takes no input parameters and returns no values. Right after this method is called, this StructuredProxyPushSupplier will resume forwarding events to the StructuredPushConsumer connected to it, including those which have been queued during the time the connection was suspended, and have not yet timed out.

Throws:

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

NotConnected - If no StructuredPushConsumer 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 StructuredProxyPushSupplier interface to stop sending events to the StructuredPushConsumer instance connected to it. If this method is called, this StructuredProxyPushSupplier will not forward events to the StructuredPushConsumer connected to it until resume_connection is subsequently invoked. During this time, the StructuredProxyPushSupplier will continue to queue events destined for the StructuredPushConsumer, although events that time out prior to resumption of the connection will be discarded. Upon resumption of the connection, all queued events will be forwarded to the StructuredPushConsumer. 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 StructuredPushConsumer has been connected to the target object when this operation is invoked.

connect_structured_push_consumer

void connect_structured_push_consumer(StructuredPushConsumer push_consumer)
                                      throws AlreadyConnected,
                                             TypeError

This operation is thus invoked in order to establish a connection between a push-style consumer of events in the form of Structured Events, and the notification channel. Once established, the StructuredProxyPushSupplier will proceed to send events destined for the consumer to it by invoking its push_structured_event operation.

Parameters:

push_consumer - The reference to an object supporting the StructuredPushConsumer interface defined within the CosNotifyComm module. This reference is that of a consumer that will receive events from 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 consumer object, the AlreadyConnected exception will be raised.

TypeError - If the push consumer being connected does not meet additional requirements, which this implementation impose on the interface supported by a push consumer (e.g., it may be designed to invoke some operation other than push_structured_event in order to transmit events).