org.omg.CosNotifyChannelAdmin

Class _ProxyPullSupplierStub

public class _ProxyPullSupplierStub extends ObjectImpl implements ProxyPullSupplier

The ProxyPullSupplier interface supports connections to the channel by consumers who will pull events from the channel as untyped Anys. Through inheritance of the ProxySupplier interface, the ProxyPullSupplier interface supports administration of various QoS properties, administration of a list of associated filter objects, mapping filters for event priority and lifetime, and a readonly attribute containing the reference of the ConsumerAdmin object which created it. In addition, this inheritance implies that a ProxyPullSupplier instance supports an operation which will return the list of event types which the proxy supplier will potentially by supplying, and an operation which can return information about the instances ability to accept a per-event QoS request. The ProxyPullSupplier interface also inherits from the PullSupplier interface defined within the CosNotifyComm module. This interface supports the pull and try_pull operations which the consumer connected to a ProxyPullSupplier instance will invoke to receive an event from the channel in the form of an Any, and the operation required to disconnect the ProxyPullSupplier from its associated consumer. In addition, since the inherited PullSupplier interface inherits the CosNotifyComm::NotifySubscribe interface, an instance supporting the ProxyPullSupplier interface can be informed whenever the list of event types that the consumer connected to it is interested in receiving changes. Finally, the ProxyPullSupplier interface defines the operation which can be invoked by a pull consumer to establish the connection over which the pull consumer will receive events from the channel. Note that this can be either a pure event service style, or a notification service style pull consumer.
Method Summary
intadd_filter(Filter new_filter)
Operation add_filter
voidconnect_any_pull_consumer(PullConsumer pull_consumer)
Operation connect_any_pull_consumer
voiddisconnect_pull_supplier()
Operation disconnect_pull_supplier
int[]get_all_filters()
Operation get_all_filters
Filterget_filter(int filter)
Operation get_filter
Property[]get_qos()
Operation get_qos
MappingFilterlifetime_filter()
Read accessor for lifetime_filter attribute
voidlifetime_filter(MappingFilter value)
Write accessor for lifetime_filter attribute
ConsumerAdminMyAdmin()
Read accessor for MyAdmin attribute
ProxyTypeMyType()
Read accessor for MyType attribute
EventType[]obtain_offered_types(ObtainInfoMode mode)
Operation obtain_offered_types
MappingFilterpriority_filter()
Read accessor for priority_filter attribute
voidpriority_filter(MappingFilter value)
Write accessor for priority_filter attribute
Anypull()
Operation pull
voidremove_all_filters()
Operation remove_all_filters
voidremove_filter(int filter)
Operation remove_filter
voidset_qos(Property[] qos)
Operation set_qos
voidsubscription_change(EventType[] added, EventType[] removed)
Operation subscription_change
Anytry_pull(BooleanHolder has_event)
Operation try_pull
voidvalidate_event_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos)
Operation validate_event_qos
voidvalidate_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos)
Operation validate_qos
String[]_ids()

Method Detail

add_filter

public int add_filter(Filter new_filter)
Operation add_filter

connect_any_pull_consumer

public void connect_any_pull_consumer(PullConsumer pull_consumer)
Operation connect_any_pull_consumer

disconnect_pull_supplier

public void disconnect_pull_supplier()
Operation disconnect_pull_supplier

get_all_filters

public int[] get_all_filters()
Operation get_all_filters

get_filter

public Filter get_filter(int filter)
Operation get_filter

get_qos

public Property[] get_qos()
Operation get_qos

lifetime_filter

public MappingFilter lifetime_filter()
Read accessor for lifetime_filter attribute

Returns: the attribute value

lifetime_filter

public void lifetime_filter(MappingFilter value)
Write accessor for lifetime_filter attribute

Parameters: value the attribute value

MyAdmin

public ConsumerAdmin MyAdmin()
Read accessor for MyAdmin attribute

Returns: the attribute value

MyType

public ProxyType MyType()
Read accessor for MyType attribute

Returns: the attribute value

obtain_offered_types

public EventType[] obtain_offered_types(ObtainInfoMode mode)
Operation obtain_offered_types

priority_filter

public MappingFilter priority_filter()
Read accessor for priority_filter attribute

Returns: the attribute value

priority_filter

public void priority_filter(MappingFilter value)
Write accessor for priority_filter attribute

Parameters: value the attribute value

pull

public Any pull()
Operation pull

remove_all_filters

public void remove_all_filters()
Operation remove_all_filters

remove_filter

public void remove_filter(int filter)
Operation remove_filter

set_qos

public void set_qos(Property[] qos)
Operation set_qos

subscription_change

public void subscription_change(EventType[] added, EventType[] removed)
Operation subscription_change

try_pull

public Any try_pull(BooleanHolder has_event)
Operation try_pull

validate_event_qos

public void validate_event_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos)
Operation validate_event_qos

validate_qos

public void validate_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos)
Operation validate_qos

_ids

public String[] _ids()