Erlang -- CosNotifyChannelAdmin_ConsumerAdmin

User's Guide
Reference Manual
Release Notes
PDF
Top

cosNotification
Reference Manual
Version 1.1.18

Expand All
Contract All

Table of Contents

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

# CosNotifyChannelAdmin_ConsumerAdmin

### MODULE

CosNotifyChannelAdmin_ConsumerAdmin

### MODULE SUMMARY

This module implements the OMG CosNotifyChannelAdmin::ConsumerAdmin 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:

- CosNotification_QoSAdmin

- CosNotifyComm_NotifySubscribe

- CosNotifyFilter_FilterAdmin

### EXPORTS

_get_MyID(ConsumerAdmin) -> AdminID

Types:

ConsumerAdmin = #objref
AdminID = long()

The ID returned by the creating channel is equal to the value encapsulated by this readonly attribute.

_get_MyChannel(ConsumerAdmin) -> Channel

Types:

ConsumerAdmin = #objref
Channel = #objref

The creating channel's reference is maintained by this readonly attribute.

_get_MyOperator(ConsumerAdmin) -> OpType

Types:

ConsumerAdmin = #objref
OpType = 'AND_OP' | 'OR_OP'

When ConsumerAdmin's are created an operation type, i.e., 'AND_OP' or 'OR_OP', is supplied, which determines the semantics used by the target object concerning evaluation against any associated Filter objects.

_get_priority_filter(ConsumerAdmin) -> MappingFilter

Types:

ConsumerAdmin = MappingFilter = #objref

If set, this operation returns the associated priority MappingFilter, otherwise a NIL object reference is returned.

_set_priority_filter(ConsumerAdmin, MappingFilter) -> ok

Types:

ConsumerAdmin = MappingFilter = #objref

To associate a priority MappingFilter with the target object this operation must be used.

_get_lifetime_filter(ConsumerAdmin) -> MappingFilter

Types:

ConsumerAdmin = MappingFilter = #objref

Unless a lifetime MappingFilter have been associated with the target object a NIL object reference is returned by this operation.

_set_lifetime_filter(ConsumerAdmin, MappingFilter) -> ok

Types:

ConsumerAdmin = MappingFilter = #objref

This operation associate a lifetime MappingFilter with the target object.

_get_pull_suppliers(ConsumerAdmin) -> ProxyIDSeq

Types:

ConsumerAdmin = #objref
ProxyIDSeq = [ProxyID]
ProxyID = long()

This readonly attribute maintains the Id's for all PullProxies created by the target object and still alive.

_get_push_suppliers(ConsumerAdmin) -> ProxyIDSeq

Types:

ConsumerAdmin = #objref
ProxyIDSeq = [ProxyID]
ProxyID = long()

This attribute is similar to the _get_pull_suppliers attribute but maintains the Id's for all PushProxies created by the target object and still alive.

get_proxy_supplier(ConsumerAdmin, ProxyID) -> Reply

Types:

ConsumerAdmin = #objref
ProxyID = long()
Reply = Proxy | {'EXCEPTION', #'CosNotifyChannelAdmin_ProxyNotFound'{}}
Proxy = #objref

If a proxy with the given Id exists the reference to the object is returned, but if the object have terminated, or an incorrect Id is supplied, an exception is raised.

obtain_notification_pull_supplier(ConsumerAdmin, ConsumerType) -> Reply

Types:

ConsumerAdmin = #objref
ConsumerType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'
Reply = {Proxy, ProxyID}
Proxy = #objref
ProxyID = long()

Determined by the parameter ConsumerType, a proxy which will accept events of the defined type is created. Along with the object reference an Id is returned.

obtain_pull_supplier(ConsumerAdmin) -> Proxy

Types:

ConsumerAdmin = #objref
Proxy = #objref

This operation creates a new proxy which accepts #any{} events.

obtain_notification_push_supplier(ConsumerAdmin, ConsumerType) -> Reply

Types:

ConsumerAdmin = #objref
ConsumerType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'
Reply = {Proxy, ProxyID}
Proxy = #objref
ProxyID = long()

A proxy which accepts events of the type described by the parameter ConsumerType is created by this operation. A unique Id is returned as an out parameter.

obtain_push_supplier(ConsumerAdmin) -> Proxy

Types:

ConsumerAdmin = #objref
Proxy = #objref

The object created by this function is a proxy which accepts #any{} events.

destroy(ConsumerAdmin) -> ok

Types:

ConsumerAdmin = #objref

To terminate the target object this operation should be used. The associated Channel will be notified.