cosNotification

Reference Manual

Version 1.2.3

- User's Guide
- Reference Manual
- Release Notes
- PDF
- Top

- Expand All
- Contract All

### Table of Contents

- cosNotificationApp
  - Top of manual page
  - create_structured_event/6
  - install/0
  - install/1
  - install_event/0
  - install_event/1
  - start/0
  - start_factory/0
  - start_factory/1
  - start_filter_factory/0
  - start_global_factory/0
  - start_global_factory/1
  - stop/0
  - stop_factory/1
  - stop_filter_factory/1
  - type_check/0
  - uninstall/0
  - uninstall/1
  - uninstall_event/0
  - uninstall_event/1
- CosNotifyChannelAdmin_EventChannelFactory
  - Top of manual page
  - create_channel/3
  - get_all_channels/1
  - get_event_channel/2
- CosNotifyChannelAdmin_EventChannel
  - Top of manual page
  - destroy/1
  - for_consumers/1
  - for_suppliers/1
  - get_all_consumeradmins/1
  - get_all_supplieradmins/1
  - get_consumeradmin/2
  - get_supplieradmin/2
  - new_for_consumers/2
  - new_for_suppliers/2
  - _get_MyFactory/1
  - _get_default_consumer_admin/1
  - _get_default_filter_factory/1
  - _get_default_supplier_admin/1
- CosNotification
  - Top of manual page
  - 'AnyOrder'/0
  - 'BestEffort'/0
  - 'ConnectionReliability'/0
  - 'DeadlineOrder'/0
  - 'DefaultPriority'/0
  - 'DiscardPolicy'/0
  - 'EventReliability'/0
  - 'FifoOrder'/0
  - 'HighestPriority'/0
  - 'LifoOrder'/0
  - 'LowestPriority'/0
  - 'MaxConsumers'/0
  - 'MaxEventsPerConsumer'/0
  - 'MaxQueueLength'/0
  - 'MaxSuppliers'/0
  - 'MaximumBatchSize'/0
  - 'OrderPolicy'/0
  - 'PacingInterval'/0
  - 'Persistent'/0
  - 'Priority'/0
  - 'PriorityOrder'/0
  - 'RejectNewEvents'/0
  - 'StartTime'/0
  - 'StartTimeSupported'/0
  - 'StopTime'/0
  - 'StopTimeSupported'/0
  - 'Timeout'/0
- CosNotification_QoSAdmin
  - Top of manual page
  - get_qos/1
  - set_qos/2
  - validate_qos/2
- CosNotification_AdminPropertiesAdmin
  - Top of manual page
  - get_admin/1
  - set_admin/2
- CosNotifyChannelAdmin_ConsumerAdmin
  - Top of manual page
  - destroy/1
  - get_proxy_supplier/2
  - obtain_notification_pull_supplier/2
  - obtain_notification_push_supplier/2
  - obtain_pull_supplier/1
  - obtain_push_supplier/1
  - _get_MyChannel/1
  - _get_MyID/1
  - _get_MyOperator/1
  - _get_lifetime_filter/1
  - _get_priority_filter/1
  - _get_pull_suppliers/1
  - _get_push_suppliers/1
  - _set_lifetime_filter/2
  - _set_priority_filter/2
- CosNotifyChannelAdmin_SupplierAdmin
  - Top of manual page
  - destroy/1
  - get_proxy_consumer/2
  - obtain_notification_pull_consumer/2
  - obtain_notification_push_consumer/2
  - obtain_pull_consumer/1
  - obtain_push_consumer/1
  - _get_MyChannel/1
  - _get_MyID/1
  - _get_MyOperator/1
  - _get_pull_consumers/1
  - _get_push_consumers/1
- CosNotifyComm_NotifyPublish
  - Top of manual page
  - offer_change/3
- CosNotifyComm_NotifySubscribe
  - Top of manual page
  - subscription_change/3
- CosNotifyFilter_FilterAdmin
  - Top of manual page
  - add_filter/2
  - get_all_filters/1
  - get_filter/2
  - remove_all_filters/1
  - remove_filter/2
- CosNotifyFilter_FilterFactory
  - Top of manual page
  - create_filter/2
  - create_mapping_filter/2
- CosNotifyFilter_Filter
  - Top of manual page
  - add_constraints/2
  - attach_callback/2
  - destroy/1
  - detach_callback/2
  - get_all_constraints/1
  - get_callbacks/1
  - get_constraints/2
  - match/2
  - match_structured/2
  - modify_constraints/3
  - remove_all_constraints/1
  - _get_constraint_grammar/1
- CosNotifyFilter_MappingFilter
  - Top of manual page
  - add_mapping_constraints/2
  - destroy/1
  - get_all_mapping_constraints/1
  - get_mapping_constraints/2
  - match/2
  - match_structured/2
  - modify_constraints/3
  - remove_all_mapping_constraints/1
  - _get_constraint_grammar/1
  - _get_default_value/1
  - _get_value_type/1
- CosNotifyChannelAdmin_ProxyConsumer
  - Top of manual page
  - obtain_subscription_types/2
  - validate_event_qos/2
  - _get_MyAdmin/1
  - _get_MyType/1
- CosNotifyChannelAdmin_ProxySupplier
  - Top of manual page
  - obtain_offered_types/2
  - validate_event_qos/2
  - _get_MyAdmin/1
  - _get_MyType/1
  - _get_lifetime_filter/1
  - _get_priority_filter/1
  - _set_lifetime_filter/2
  - _set_priority_filter/2
- CosNotifyChannelAdmin_ProxyPullConsumer
  - Top of manual page
  - connect_any_pull_supplier/2
  - disconnect_pull_consumer/1
  - resume_connection/1
  - suspend_connection/1
- CosNotifyChannelAdmin_ProxyPullSupplier
  - Top of manual page
  - connect_any_pull_consumer/2
  - disconnect_pull_supplier/1
  - pull/1
  - try_pull/1
- CosNotifyChannelAdmin_ProxyPushConsumer
  - Top of manual page
  - connect_any_push_supplier/2
  - disconnect_push_consumer/1
  - push/2
- CosNotifyChannelAdmin_ProxyPushSupplier
  - Top of manual page
  - connect_any_push_consumer/2
  - disconnect_push_supplier/1
  - resume_connection/1
  - suspend_connection/1
- CosNotifyChannelAdmin_SequenceProxyPullConsumer
  - Top of manual page
  - connect_sequence_pull_supplier/2
  - disconnect_sequence_pull_consumer/1
  - resume_connection/1
  - suspend_connection/1
- CosNotifyChannelAdmin_SequenceProxyPullSupplier
  - Top of manual page
  - connect_sequence_pull_consumer/2
  - disconnect_sequence_pull_supplier/1
  - pull_structured_events/2
  - try_pull_structured_events/2
- CosNotifyChannelAdmin_SequenceProxyPushConsumer
  - Top of manual page
  - connect_sequence_push_supplier/2
  - disconnect_sequence_push_consumer/1
  - push_structured_events/2
- CosNotifyChannelAdmin_SequenceProxyPushSupplier
  - Top of manual page
  - connect_sequence_push_consumer/2
  - disconnect_sequence_push_supplier/1
  - resume_connection/1
  - suspend_connection/1
- CosNotifyChannelAdmin_StructuredProxyPullConsumer
  - Top of manual page
  - connect_structured_pull_supplier/2
  - disconnect_structured_pull_consumer/1
  - resume_connection/1
  - suspend_connection/1
- CosNotifyChannelAdmin_StructuredProxyPullSupplier
  - Top of manual page
  - connect_structured_pull_consumer/2
  - disconnect_structured_pull_supplier/1
  - pull_structured_event/1
  - try_pull_structured_event/1
- CosNotifyChannelAdmin_StructuredProxyPushConsumer
  - Top of manual page
  - connect_structured_push_supplier/2
  - disconnect_structured_push_consumer/1
  - push_structured_event/2
- CosNotifyChannelAdmin_StructuredProxyPushSupplier
  - Top of manual page
  - connect_structured_push_consumer/2
  - disconnect_structured_push_supplier/1
  - resume_connection/1
  - suspend_connection/1

# CosNotifyChannelAdmin_SequenceProxyPullSupplier

### Module

CosNotifyChannelAdmin_SequenceProxyPullSupplier

### Module Summary

This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPullSupplier interface.

### Description

To get access to the record definitions for the structures use:
-include_lib("cosNotification/include/*.hrl").

This module also exports the functions described in:

- CosNotifyComm_NotifySubscribe

- CosNotification_QoSAdmin

- CosNotifyFilter_FilterAdmin

- CosNotifyChannelAdmin_ProxySupplier

### Exports

connect_sequence_pull_consumer(SequenceProxyPullSupplier, PullConsumer) -> Reply

### Types

SequenceProxyPullSupplier = #objref
PullConsumer = #objref
Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}

This operation connects a PullConsumer to the target object. If a connection already exists an exception is raised.

pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Reply

### Types

SequenceProxyPullSupplier = #objref
MaxEvents = long()
Reply = EventBatch | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}
EventBatch = [StructuredEvent]
StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}
header = EventHeader
filterable_data = [#'CosNotification_Property'{name, value}]
name = string()
value = #any
remainder_of_body = #any
EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}
fixed_header = FixedEventHeader
variable_header = OptionalHeaderFields
FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}
event_type = EventType
event_name = string()
EventType = #'CosNotification_EventType'{domain_name, type_name}
domain_name = type_name = string()
OptionalHeaderFields = [#'CosNotification_Property'{name, value}]

A client use this operation to pull next event sequence of maximum length MaxEvents. This operation is blocking and will not reply until the requested amount of events can be delivered or the QoS property PacingInterval is reached. For more information see the User's Guide.

try_pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Reply

### Types

SequenceProxyPullSupplier = #objref
MaxEvents = long()
Reply = {EventBatch, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}
HasEvent = boolean()
EventBatch = [StructuredEvent]
StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}
header = EventHeader
filterable_data = [#'CosNotification_Property'{name, value}]
name = string()
value = #any
remainder_of_body = #any
EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}
fixed_header = FixedEventHeader
variable_header = OptionalHeaderFields
FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}
event_type = EventType
event_name = string()
EventType = #'CosNotification_EventType'{domain_name, type_name}
domain_name = type_name = string()
OptionalHeaderFields = [#'CosNotification_Property'{name, value}]

This operation pulls an event sequence of the maximum length MaxEvents, but do not block if the target object have no events to forward. The outparameter, HasEvent is true if the sequence contain any events.

disconnect_sequence_pull_supplier(SequenceProxyPullSupplier) -> ok

### Types

SequenceProxyPullSupplier = #objref

This operation cause the target object to close the connection and terminate.