COSNOTIFYCHANNELADMIN_PROXYPULLCONSUMER(3erl)

πŸ“¦
version 5.2.2 Β· 2 versions
, in fedora 43, fedora 44

πŸ’… NAME πŸ’…

ok so this is CosNotifyChannelAdmin_ProxyPullConsumer β€” it's the Erlang module that implements the OMG CosNotifyChannelAdmin::ProxyPullConsumer interface. she's giving CORBA, she's giving notification channels, she's giving main character energy fr fr πŸŽ€

oh also the manual name is CosNotifyC...ullConsumer(3) and the manual is Erlang Module Definition, just so we're, like, oriented bestie πŸ¦‹


✨ DESCRIPTION ✨

so to even get to the record definitions for the structures, you do:

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

periodt. that's the door code. πŸ”‘

and ALSO, this module exports the functions described in these other modules, so like, she's not just one vibe, she contains multitudes:

  • CosNotifyComm_NotifyPublish
  • CosNotification_QoSAdmin
  • CosNotifyFilter_FilterAdmin
  • CosNotifyChannelAdmin_ProxyConsumer

no cap, read those too if you want the full picture πŸ‘‘


🌸 EXPORTS 🌸

connect_any_pull_supplier(ProxyPullConsumer, PullSupplier) -> Reply

Types:

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

okay so this one connects the PullSupplier you hand it to the target object. that's the whole job. BUT β€” and this is the important part β€” if a client is already connected, it raises the AlreadyConnected exception. πŸ’€

and like, the client has to support the operations pull and try_pull, otherwise you get the TypeError exception. so if your client can't pull, don't pull up. πŸ™ˆ


suspend_connection(ProxyPullConsumer) -> Reply

Types:

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

if you wanna temporarily suspend the connection with the target object, you gotta use this operation. that's the assignment. πŸ“

but bestie, if the connection already got suspended, or if no client has been connected at all, it raises an exception. like it's not gonna just sit there and pretend. 🫠


resume_connection(ProxyPullConsumer) -> Reply

Types:

ProxyPullConsumer = #objref
Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyActive'{}} |
        {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}

so if the connection got suspended earlier, you can invoke this operation to reinstate it. we love a comeback arc, it's giving renaissance. ✨

but if the connection is already active, or no client has been connected to the target object, an exception is raised. read the room, girl. 😭


disconnect_pull_consumer(ProxyPullConsumer) -> ok

Types:

ProxyPullConsumer = #objref

invoking this operation disconnects the client from the target object β€” which then terminates and informs its administrative parent. like she's leaving the group chat and telling the mods on her way out. πŸ’…

no exceptions listed here, just ok. slay, a clean exit. πŸ‘‘


ngl the whole vibe of this module is: connect, suspend, resume, disconnect. four moves. iconic behavior honestly. πŸ”₯

ok that's the whole page bestie, go forth and pull 🧚

this lil manual came from Ericsson AB, and it's part of cosNotification 5.2.2 β€” specifically the CosNotifyC...ullConsumer(3) page. mwah, take care of her πŸ’–πŸŒˆ

πŸ“¦ where this page comes from