User's Guide
Reference Manual
Release Notes
PDF
Top

cosEvent
Reference Manual
Version 2.1.8

Expand All
Contract All

Table of Contents

- cosEventApp
  - Top of manual page
  - install/0
  - uninstall/0
  - start/0
  - stop/0
  - start_channel/0
  - start_channel/1
  - start_channel_link/0
  - start_channel_link/1
  - stop_channel/1
- CosEventChannelAdmin
- CosEventChannelAdmin_ConsumerAdmin
  - Top of manual page
  - obtain_push_supplier/1
  - obtain_pull_supplier/1
- CosEventChannelAdmin_SupplierAdmin
  - Top of manual page
  - obtain_push_consumer/1
  - obtain_pull_consumer/1
- CosEventChannelAdmin_EventChannel
  - Top of manual page
  - for_consumers/1
  - for_suppliers/1
  - destroy/1
- CosEventChannelAdmin_ProxyPullConsumer
  - Top of manual page
  - connect_pull_supplier/2
  - disconnect_pull_consumer/1
- CosEventChannelAdmin_ProxyPushConsumer
  - Top of manual page
  - connect_push_supplier/2
  - disconnect_push_consumer/1
  - push/2
- CosEventChannelAdmin_ProxyPullSupplier
  - Top of manual page
  - connect_pull_consumer/2
  - disconnect_pull_supplier/1
  - pull/1
  - try_pull/1
- CosEventChannelAdmin_ProxyPushSupplier
  - Top of manual page
  - connect_push_consumer/2
  - disconnect_push_supplier/1

# CosEventChannelAdmin_ConsumerAdmin

### MODULE

CosEventChannelAdmin_ConsumerAdmin

### MODULE SUMMARY

This module implements a ConsumerAdmin interface, which allows consumers to be connected to the event channel.

### DESCRIPTION

The ConsumerAdmin interface defines the first step for connecting consumers to the event channel. It acts as a factory for creating proxy suppliers. Both consumer administration and supplier administration are defined as separate objects so that the creator of the channel can control the addition of suppliers and consumers.

To get access to all definitions include necessary hrl files by using:
-include_lib("cosEvent/include/*.hrl").

### EXPORTS

obtain_push_supplier(Object) -> Return

Types:

Object = #objref
Return = #objref

This operation returns a ProxyPushSupplier object reference.

obtain_pull_supplier(Object) -> Return

Types:

Object = #objref
Return = #objref

This operation returns a ProxyPullSupplier object reference.