org.omg.CosNotifyChannelAdmin
Interface SequenceProxyPullConsumerOperations
- All Superinterfaces:
- FilterAdminOperations, NotifyPublishOperations, ProxyConsumerOperations, QoSAdminOperations, SequencePullConsumerOperations
- All Known Subinterfaces:
- SequenceProxyPullConsumer
- All Known Implementing Classes:
- _SequenceProxyPullConsumerStub, SequenceProxyPullConsumerImpl, SequenceProxyPullConsumerPOA, SequenceProxyPullConsumerPOATie
public interface SequenceProxyPullConsumerOperations
- extends ProxyConsumerOperations, SequencePullConsumerOperations
The SequenceProxyPullConsumer interface supports connections to the channel by
suppliers who will make events available for pulling to the channel as sequences of
Structured Events. Through inheritance of the ProxyConsumer interface, the
SequenceProxyPullConsumer 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 SequenceProxyPullConsumer 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 SequenceProxyPullConsumer interface also inherits from the
SequencePullConsumer interface defined in the CosNotifyComm module. This
interface supports the operation which can be invoked to close down the connection
from the supplier to the SequenceProxyPullConsumer. In addition, since the
SequencePullConsumer interface inherits from the NotifyPublish interface, a
supplier can inform the SequenceProxyPullConsumer to which it is connected
whenever the list of event types it plans to supply to the channel changes.
Lastly, the SequenceProxyPullConsumer interface defines a method that can be
invoked by a pull-style supplier of sequences 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. The SequenceProxyPullConsumer interface also defines
a pair of operations which can suspend and resume the connection between a
SequenceProxyPullConsumer instance and its associated SequencePullSupplier.
During the time such a connection is suspended, the SequenceProxyPullConsumer
will not attempt to pull events from its associated SequencePullSupplier.
Method Summary |
void |
connect_sequence_pull_supplier(SequencePullSupplier pull_supplier)
The connect_sequence_pull_supplier operation accepts as an input parameter the
reference to an object supporting the SequencePullSupplier interface defined within
the CosNotifyComm module. |
void |
resume_connection()
The resume_connection operation causes the target object supporting the
SequenceProxyPullConsumer interface to resume attempting to pull events (using
pull or try_pull) from the SequencePullSupplier instance connected to it. |
void |
suspend_connection()
The suspend_connection operation causes the target object supporting the
SequenceProxyPullConsumer interface to stop attempting to pull events (using pull
or try_pull) from the SequencePullSupplier instance connected to it. |
connect_sequence_pull_supplier
void connect_sequence_pull_supplier(SequencePullSupplier pull_supplier)
throws AlreadyConnected,
TypeError
- The connect_sequence_pull_supplier operation accepts as an input parameter the
reference to an object supporting the SequencePullSupplier interface defined within
the CosNotifyComm module. This reference is that of a supplier which plans to make
events available for pulling to the channel with which the target object is associated in
the form of sequences of Structured Events. This operation is thus invoked in order to
establish a connection between a pull-style supplier of events in the form of sequences
of Structured Events, and the notification channel. Once established, the channel can
proceed to receive events from the supplier by invoking the pull_structured_events or
try_pull_structured_events operations supported by the supplier (whether the channel
will invoke pull_structured_events or try_pull_structured_events, and the frequency
with which it will perform such invocations, is a detail which is specific to the
implementation of the channel). If the target object of this operation is already
connected to a pull supplier object, the AlreadyConnected exception will be raised.
An implementation of the SequenceProxyPullConsumer interface may impose
additional requirements on the interface supported by a pull supplier (e.g., it may be
designed to invoke some operation other than pull_structured_events or
try_pull_structured_events in order to receive events). If the pull supplier being
connected does not meet those requirements, this operation raises the TypeError
exception.
- Throws:
AlreadyConnected
TypeError
suspend_connection
void suspend_connection()
throws ConnectionAlreadyInactive,
NotConnected
- The suspend_connection operation causes the target object supporting the
SequenceProxyPullConsumer interface to stop attempting to pull events (using pull
or try_pull) from the SequencePullSupplier instance connected to it. This operation
takes no input parameters and returns no values. If the connection has been previously
suspended using this operation and not resumed by invoking resume_connection
(described below), the ConnectionAlreadyInactive exception is raised. If no
SequencePullSupplier has been connected to the target object when this operation is
invoked, the NotConnected exception is raised. Otherwise, the
SequenceProxyPullConsumer will not attempt to pull events from the
SeuqencePullSupplier connected to it until resume_connection is subsequently
invoked.
- Throws:
ConnectionAlreadyInactive
NotConnected
resume_connection
void resume_connection()
throws ConnectionAlreadyActive,
NotConnected
- The resume_connection operation causes the target object supporting the
SequenceProxyPullConsumer interface to resume attempting to pull events (using
pull or try_pull) from the SequencePullSupplier instance connected to it. This
operation takes no input parameters and returns no values. If the connection has not
been previously suspended using this operation by invoking suspend_connection
(described above), the ConnectionAlreadyActive exception is raised. If no
SequencePullSupplier has been connected to the target object when this operation is
invoked, the NotConnected exception is raised. Otherwise, the
SequenceProxyPullConsumer will resume attempting to pull events from the
SequencePullSupplier connected to it.
- Throws:
ConnectionAlreadyActive
NotConnected