1997 2016 Ericsson AB, All Rights Reserved Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The Initial Developer of the Original Code is Ericsson AB. CosEventChannelAdmin_ProxyPullSupplier Lars Thors 1997-11-13 PA1 CosEventChannelAdmin_ProxyPullSupplier.xml
CosEventChannelAdmin_ProxyPullSupplier This module implements a ProxyPullSupplier interface which acts as a middleman between pull consumer and the event channel.

The ProxyPullSupplier interface defines the second step for connecting pull consumers to the event channel. A proxy supplier is similar to a normal supplier, but includes an additional method for connecting a consumer to the proxy supplier.

To get access to all definitions, e.g., exceptions, include necessary files by using:

Any object that possesses an object reference that supports the ProxyPullSupplier interface can perform the following operations:

 connect_pull_consumer(Object, PullConsumer) -> Return Connect the pull consumer to the proxy pull supplier Object = #objref PullConsumer = #objref of PullConsumer type Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}

This operation connects PullConsumer object to the ProxyPullSupplier object. A nil object reference can be passed to this operation. If so a channel cannot invoke the disconnect_pull_consumer operation on the consumer; the consumer may be disconnected from the channel without being informed. If the ProxyPullSupplier is already connected to a PullConsumer, then the exception is raised.

 disconnect_pull_supplier(Object) -> Return Disconnect the ProxyPullSupplier object from the event channel. Object = #objref Return = ok

This operation disconnects proxy pull supplier from the event channel. It sends a notification about the loss of the connection to the pull consumer attached to it, unless nil object reference was passed at the connection time.

 pull(Object) -> Return Transmit data from suppliers to consumers. Object = #objref Return = any

This operation blocks until the event data is available or the exception is raised. It returns the event data to the consumer.

 try_pull(Object) -> Return Transmit data from suppliers to consumers. Object = #objref Return = {any, bool()}

This operation does not block: if the event data is available, it returns the event data and sets the data availability flag to true; otherwise it returns a long with an undefined value and sets the data availability to false. If the event communication has already been disconnected, the exception is raised.