---
name: "CosNotifyChannelAdmin_ConsumerAdmin"
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_ConsumerAdmin"
---

# CosNotifyChannelAdmin\_ConsumerAdmin(3erl)

This module implements the OMG CosNotifyChannelAdmin::ConsumerAdmin interface.

## NAME

CosNotifyChannelAdmin\_ConsumerAdmin - 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.