COSNOTIFYCHANNELADMIN_EVENTCHANNELFACTORY(3erl)

🦋 CosNotifyChannelAdmin_EventChannelFactory 🦋

okay bestie, welcome to the manual page for CosNotifyChannelAdmin_EventChannelFactory, which lives in the 3erl manual (Erlang Module Definition section, if you're keeping score). This is the module that implements the OMG CosNotifyChannelAdmin::EventChannelFactory interface. it's giving factory-core, it's giving channel-management realness, and yes we are going to read the whole thing together. periodt. 💅

---

✨ NAME ✨

CosNotifyChannelAdmin_EventChannelFactory — this module implements the OMG CosNotifyChannelAdmin::EventChannelFactory interface. no cap, that's the whole name section. 💖

---

🌸 DESCRIPTION 🌸

so like, if you wanna get access to the record definitions for the structures, you do this:

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

that's it, that's the vibe. go get your headers, bestie. 🎀

---

👑 EXPORTS 👑

🫶 create_channel(ChannelFactory, InitialQoS, InitialAdmin) -> Return

Types:

ChannelFactory = #objref
InitialQoS = CosNotification::QoSProperties
InitialAdmin = CosNotification::AdminProperties
Return = {EventChannel, ChannelID}
EventChannel = #objref
ChannelID = long()

okay so this operation creates a brand new event channel. iconic behavior honestly. 🔥

along with the channel reference, you also get an id back — and that id? super important, because you'll use it when invoking other operations exported by this module. so like, don't lose it. the Quality of Service argument you supply will be inherited by objects created by the channel. (the children inherit the vibe, as they should. 💜)

for more information about QoS settings, see the User's Guide.

and listen — if no QoS- and/or Admin-properties are supplied (i.e. an empty list), the default settings will be used instead. for more information, see the User's Guide. 💖

---

🌈 get_all_channels(ChannelFactory) -> ChannelIDSeq

Types:

ChannelFactory = #objref
ChannelIDSeq = [long()]

this one returns an id sequence of all the channels created by this ChannelFactory. every single one. the whole roster. the entire friend group. ✨

---

🧚 get_event_channel(ChannelFactory, ChannelID) -> Return

Types:

ChannelFactory = #objref
ChannelID = long()
Retrurn = EventChannel | {'EXCEPTION',
#'CosNotifyChannelAdmin_ChannelNotFound'{}}
EventChannel = #objref

(yes bestie, that type is spelled Retrurn in the original and i am simply respecting its journey. 💀)

this operation returns the EventChannel associated with the given id. simple, right?

⚠️ but if no channel is associated with that id — like, it never existed, or it's been terminated — an exception is raised. so be ready for that, okay? 'CosNotifyChannelAdmin_ChannelNotFound'{} is coming for you. 😭

---

and that's the whole page, no skips, no summaries, we read every last line together like the devoted besties we are. 🫶

signing off ✨ this page came to you courtesy of Ericsson AB, from the cosNotification 5.2.2 era, and the footer timestamp on it is CosNotifyC...nnelFactory(3). mwah. 💅🎀🦋