User's Guide
Reference Manual
Release Notes
PDF
Top

cosNotification
Reference Manual
Version 1.1.18

Expand All
Contract All

Table of Contents

# CosNotifyChannelAdmin_ProxyPullSupplier

### MODULE

CosNotifyChannelAdmin_ProxyPullSupplier

### MODULE SUMMARY

This module implements the OMG CosNotifyChannelAdmin::ProxyPullSupplier 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_any_pull_consumer(ProxyPullSupplier, PullConsumer) -> Reply

Types:

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

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

pull(ProxyPullSupplier) -> Reply

Types:

ProxyPullSupplier = #objref
Reply = #any | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}

This operation pulls next #any{} event, and blocks, if the target object have no events to forward, until an event can be delivered. If no client have been connected the Disconnected exception is raised.

try_pull(ProxyPullSupplier) -> Reply

Types:

ProxyPullSupplier = #objref
Reply = {#any, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}
HasEvent = boolean()

This operation pulls next event, but do not block if the target object have no event to forward. If no client have been connected the Disconnected exception is raised.

disconnect_pull_supplier(ProxyPullSupplier) -> ok

Types:

ProxyPullSupplier = #objref

Invoking this operation will cause the target object to close the connection and terminate.