COSNOTIFYCHANNELADMIN_SUPPLIERADMIN(3erl)

💖 CosNotifyChannelAdmin_SupplierAdmin 💖

ok so bestie, this is the manual page for CosNotifyChannelAdmin_SupplierAdmin, part of the Erlang module definitions for cosNotification (version 5.2.2, courtesy of Ericsson AB — more on that at the bottom 🫶).

---

✨ NAME ✨

CosNotifyChannelAdmin_SupplierAdmin — this module implements the OMG CosNotifyChannelAdmin::SupplierAdmin interface. no cap, that's literally what it is. 💅

---

🌸 DESCRIPTION 🌸

okay so first thing first, to get access to the record definitions for the structures, you're gonna want to use:

-include_lib("cosNotification/include/*.hrl").

that's your little ticket in, bestie. don't skip it. 🎀

This module also exports the functions described in:

• CosNotification_QoSAdmin
• CosNotifyComm_NotifyPublish
• CosNotifyFilter_FilterAdmin

so like, it's giving ✨inherited responsibilities✨. it does a lot. main character energy fr fr.

---

👑 EXPORTS 👑

💜 _get_MyID(SupplierAdmin) -> AdminID

Types:

SupplierAdmin = #objref
AdminID = long()

When a SupplierAdmin object gets created, the channel that made it hands it a unique Id. This readonly attribute is where that Id lives. it's like its little birth certificate. 🌈

---

💜 _get_MyChannel(SupplierAdmin) -> Channel

Types:

SupplierAdmin = #objref
Channel = #objref

This readonly attribute is holding onto the reference of the channel that created it. yeah, it remembers where it came from. iconic. 🥹

---

💜 _get_MyOperator(SupplierAdmin) -> OpType

Types:

SupplierAdmin = #objref
OpType = 'AND_OP' | 'OR_OP'

This readonly attribute keeps the Operation Type, and that's the thing that decides what semantics the target object will use for any associated Filters. so like, 'AND_OP' or 'OR_OP', and that's the vibe check for how filters get combined. 🔥

---

💜 _get_pull_consumers(SupplierAdmin) -> ProxyIDSeq

Types:

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

This readonly attribute maintains a sequence of all the associated PullProxy Id's. all of them. the whole squad. 💫

---

💜 _get_push_consumers(SupplierAdmin) -> ProxyIDSeq

Types:

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

This operation returns all the PushProxy Id's that were created by the target object. every single one. 🫶

---

💜 get_proxy_consumer(SupplierAdmin, ProxyID) -> Reply

Types:

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

Give it an Id, get the Proxy that corresponds to it. that's it, that's the whole job. but heads up — if there's no matching Proxy, you're getting {'EXCEPTION', #'CosNotifyChannelAdmin_ProxyNotFound'{}} thrown back at you. 😭 so like, check before you vibe.

---

💜 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 brand new proxy and hands you back its object reference plus its ID, packaged all cute together as {Proxy, ProxyID}. The SupplierType parameter is what decides which event type the proxy accepts. you choose, it complies. 💅

---

💜 obtain_pull_consumer(SupplierAdmin) -> Proxy

Types:

SupplierAdmin = #objref
Proxy = #objref

This operation creates a proxy that accepts #any{} events. all events welcome, no filter, no gatekeeping. 🦋

---

💜 obtain_notification_push_consumer(SupplierAdmin, SupplierType) -> Reply

Types:

SupplierAdmin = #objref
SupplierType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'
Reply = {Proxy, ProxyID}
Proxy = #objref
ProxyID = long()

The SupplierType parameter decides which compliant proxy gets created, and this operation returns its object reference along with its Id. same deal as the pull one, just push flavored. ⭐

---

💜 obtain_push_consumer(SupplierAdmin) -> Proxy

Types:

SupplierAdmin = #objref
Proxy = #objref

This operation creates a proxy that accepts #any{} events. yep, exactly like the pull one but pushing. symmetrical. slay. 🌸

---

💜 destroy(SupplierAdmin) -> ok

Types:

SupplierAdmin = #objref

This operation terminates the SupplierAdmin object and notifies the creating channel that the target object is no longer active. it's not ghosting, it's a formal goodbye. 💀✌️

---

real talk bestie: if you destroy it, it's gone and the channel knows. don't go calling it after that. 🙈

---

and that's the whole page, periodt. This was Ericsson AB's cosNotification version 5.2.2, and yes, this manual page has been around — go forth and manage those supplier admins responsibly, queen. 👑💖