COSNOTIFYCHANNELADMIN_STRUCTUREDPROXYPULLCONSUMER(3erl)

💖 CosNotifyChannelAdmin_StructuredProxyPullConsumer 💖

okay bestie, so this page is from the Erlang manual, CosNotifyC...ullConsumer(3), and we're about to get so into it 🫶

---

✨ NAME ✨

CosNotifyChannelAdmin_StructuredProxyPullConsumer — this module is the real one, the main character, and it implements the OMG CosNotifyChannelAdmin::StructuredProxyPullConsumer interface. no cap. 👑

---

🌸 DESCRIPTION 🌸

First things first, if you want access to the record definitions for the structures, you literally just do this:

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

That's it. That's the move. 💅

This module also exports the functions described in these other modules, so consider this your little friend group:

• CosNotifyComm_NotifyPublish
• CosNotification_QoSAdmin
• CosNotifyFilter_FilterAdmin
• CosNotifyChannelAdmin_ProxyConsumer

the way that it just inherits all that energy… obsessed. ✨

---

🦋 EXPORTS 🦋

connect_structured_pull_supplier(StructuredProxyPullConsumer, PullSupplier) -> Reply

Types:

StructuredProxyPullConsumer = #objref
PullSupplier = #objref
Reply = ok | {'EXCEPTION',
#'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION',
#'CosEventChannelAdmin_TypeError'{}}

okay so this operation connects a PullSupplier to the target object. 💖

but listen — if a connection already exists, or the given client object doesn't support the functions pull_structured_event and try_pull_structured_event, an exception gets raised. so like… don't do that. 😭

---

suspend_connection(StructuredProxyPullConsumer) -> Reply

Types:

StructuredProxyPullConsumer = #objref
Reply = ok | {'EXCEPTION',
#'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} |
{'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}

This one suspends the connection between the target object and its client. it's giving "we need a break" energy. 🧚

If no connection exists, or it's already suspended, an exception is raised. so double-check before you hit pause, bestie. 💀

---

resume_connection(StructuredProxyPullConsumer) -> Reply

Types:

StructuredProxyPullConsumer = #objref
Reply = ok | {'EXCEPTION',
#'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} |
{'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}

If the connection has been suspended, this is the operation you must use when you wanna resume it. we're back, babes. 🔥

But — if the connection is already active, or no connection has been created at all, an exception is raised. so this only works on a suspended connection. periodt. 🙈

---

disconnect_structured_pull_consumer(StructuredProxyPullConsumer) -> ok

Types:

StructuredProxyPullConsumer = #objref

This operation causes the target object to close the connection and terminate. it's the goodbye, the exit, the closing of the group chat. 💜 and it returns ok. 👑

---

Ericsson AB • cosNotification 5.2.2 • that's the whole page, bestie — mwah, take care of your proxies 🌈🎀✨