org.omg.CosNotifyChannelAdmin

Class _StructuredProxyPullSupplierStub

public class _StructuredProxyPullSupplierStub extends ObjectImpl implements StructuredProxyPullSupplier

The StructuredProxyPullSupplier interface supports connections to the channel by consumers who will pull events from the channel as Structured Events. Through inheritance of the ProxySupplier interface, the StructuredProxyPullSupplier 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 StructuredProxyPullSupplier 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 StructuredProxyPullSupplier interface also inherits from the StructuredPullSupplier interface defined in the CosNotifyComm module. This interface supports the operations which enable a consumer of Structured Events to pull them from the StructuredProxyPullSupplier, and also the operation which can be invoked to close down the connection from the consumer to the StructuredProxyPullSupplier. In addition, since the StructuredPullSupplier interface inherits from the NotifySubscribe interface, a StructuredProxyPullSupplier can be notified whenever the list of event types which its associated consumer is interested in receiving changes. This notification occurs via the callback mechanism described in section 2.3. Lastly, the StructuredProxyPullSupplier interface defines a method that can be invoked by a pull-style consumer of Structured Events in order to establish a connection between the consumer and a notification channel over which the consumer will proceed to receive events.
Method Summary
intadd_filter(Filter new_filter)
Operation add_filter
voidconnect_structured_pull_consumer(StructuredPullConsumer pull_consumer)
Operation connect_structured_pull_consumer
voiddisconnect_structured_pull_supplier()
Operation disconnect_structured_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
StructuredEventpull_structured_event()
Operation pull_structured_event
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
StructuredEventtry_pull_structured_event(BooleanHolder has_event)
Operation try_pull_structured_event
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_structured_pull_consumer

public void connect_structured_pull_consumer(StructuredPullConsumer pull_consumer)
Operation connect_structured_pull_consumer

disconnect_structured_pull_supplier

public void disconnect_structured_pull_supplier()
Operation disconnect_structured_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_structured_event

public StructuredEvent pull_structured_event()
Operation pull_structured_event

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_structured_event

public StructuredEvent try_pull_structured_event(BooleanHolder has_event)
Operation try_pull_structured_event

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()