---
name: "CosNotifyChannelAdmin_SupplierAdmin"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:19.2.1+dfsg-2+deb9u3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/CosNotifyChannelAdmin_SupplierAdmin"
---

# CosNotifyChannelAdmin\_SupplierAdmin(3erl)

This module implements the OMG CosNotifyChannelAdmin::SupplierAdmin interface.

## NAME

CosNotifyChannelAdmin\_SupplierAdmin - This module implements the OMG CosNotifyChannelAdmin::SupplierAdmin 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\_NotifyPublish**

- \*

  **CosNotifyFilter\_FilterAdmin**

## EXPORTS

**\_get\_MyID(SupplierAdmin) -\> AdminID**\

Types:

SupplierAdmin = #objref\
 AdminID = long()\

When a *SupplierAdmin* object is created it is given a unique Id by the creating channel. This readonly attribute maintains this Id.

**\_get\_MyChannel(SupplierAdmin) -\> Channel**\

Types:

SupplierAdmin = #objref\
 Channel = #objref\

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

**\_get\_MyOperator(SupplierAdmin) -\> OpType**\

Types:

SupplierAdmin = #objref\
 OpType = 'AND\_OP' \| 'OR\_OP'\

The Operation Type, which determines the semantics the target object will use for any associated *Filters*, is maintained by this readonly attribute.

**\_get\_pull\_consumers(SupplierAdmin) -\> ProxyIDSeq**\

Types:

SupplierAdmin = #objref\
 ProxyIDSeq = \[ProxyID\]\
 ProxyID = long()\

A sequence of all associated *PullProxy* Id's is maintained by this readonly attribute.

**\_get\_push\_consumers(SupplierAdmin) -\> ProxyIDSeq**\

Types:

SupplierAdmin = #objref\
 ProxyIDSeq = \[ProxyID\]\
 ProxyID = long()\

This operation returns all *PushProxy* Id's created by the target object.

**get\_proxy\_consumer(SupplierAdmin, ProxyID) -\> Reply**\

Types:

SupplierAdmin = #objref\
 ProxyID = long()\
 Reply = Proxy \| {'EXCEPTION', #'CosNotifyChannelAdmin\_ProxyNotFound'{}}\
 Proxy = #objref\

The Proxy which corresponds to the given Id is returned by this operation.

**obtain\_notification\_pull\_consumer(SupplierAdmin, SupplierType) -\> Reply**\

Types:

SupplierAdmin = #objref\
 SupplierType = 'ANY\_EVENT' \| 'STRUCTURED\_EVENT' \| 'SEQUENCE\_EVENT'\
 Reply = {Proxy, ProxyID}\
 Proxy = #objref\
 ProxyID = long()\

This operation creates a new proxy and returns its object reference along with its ID. The *SupplierType* parameter determines the event type accepted by the proxy.

**obtain\_pull\_consumer(SupplierAdmin) -\> Proxy**\

Types:

SupplierAdmin = #objref\
 Proxy = #objref\

A proxy which accepts *#any{}* events is created by this operation.

**obtain\_notification\_push\_consumer(SupplierAdmin, SupplierType) -\> Reply**\

Types:

SupplierAdmin = #objref\
 SupplierType = 'ANY\_EVENT' \| 'STRUCTURED\_EVENT' \| 'SEQUENCE\_EVENT'\
 Reply = {Proxy, ProxyID}\
 Proxy = #objref\
 ProxyID = long()\

Determined by the *SupplierType* parameter a compliant proxy is created and its object reference along with its Id is returned by this operation.

**obtain\_push\_consumer(SupplierAdmin) -\> Proxy**\

Types:

SupplierAdmin = #objref\
 Proxy = #objref\

A proxy which accepts *#any{}* events is created by this operation.

**destroy(SupplierAdmin) -\> ok**\

Types:

SupplierAdmin = #objref\

This operation terminates the SupplierAdmin object and notifies the creating channel that the target object no longer is active.