cosEventApp(3)

🌸 cosEventApp 🌸

okay bestie, this is cosEventApp(3) — an Erlang Module Definition, and it's literally the main character of the cosEvent application, no cap 👑

---

✨ NAME ✨

cosEventApp — the main module of the cosEvent application. she runs the whole show 💅

---

🦋 DESCRIPTION 🦋

so if you wanna get access to the record definitions for the structures, you gotta use this, exactly like this, don't freestyle it:

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

and that's the vibe. This module is where the functions for starting and stopping the application live. that's her whole job and she does it flawlessly fr fr ✨

---

👑 EXPORTS 👑

---

💖 install() -> Return

Types:

Return = ok | {'EXCEPTION', E} | {'EXIT', R}

This operation installs the cosEvent application. slay, she's moving in 🎀

---

💖 uninstall() -> Return

Types:

Return = ok | {'EXCEPTION', E} | {'EXIT', R}

This operation uninstalls the cosEvent application. okay bye bestie, it was real 🫶

---

💖 start() -> Return

Types:

Return = ok | {error, Reason}

This operation starts the cosEvent application. wake up queen, it's time ☀️

---

💖 stop() -> Return

Types:

Return = ok | {error, Reason}

This operation stops the cosEvent application. nap time 😴

---

💖 start_channel() -> Channel

Types:

Channel = #objref

This operation creates a new instance of a Event Channel using the default settings. no options needed, she just knows what to do 💅

---

💖 start_channel(Options) -> Channel

Types:

Options = [Option]
Option = {pull_interval, Seconds} | {typecheck, Boolean} |
{maxEvents, Integer} | {blocking, Boolean}
Channel = #objref

This operation creates a new instance of a Event Channel, and this time you get to pick the settings. here's the tea on every single option 🍓:

• {pull_interval, Seconds} — this one decides how often Proxy Pull Consumers will check for new events with the client application. the default value is 20 seconds. so yeah, every 20 seconds she's peeking 👀
• {typecheck, Boolean} — if this option is set to true the proxies will check if the supplied client object is of correct type. the default value is false. lowkey chill by default, but flip it if you're feeling strict ✨
• {maxEvents, Integer} — this option determines how many events the ProxyPullSuppliers will store before discarding events. if the limit is reached, events will be discarded in any order. the default value is 300. so yeah, once the storage is full it's chaos out here, first come first yeeted 💀
• {blocking, Boolean} — this option determines the behavior of the channel when handling events internally. if set to true, the risk of a single event supplier flooding the system is reduced, but the performance may also be reduced. the default value is true. so it's giving protective big sister energy, but she might be a little slower walking 🧚

---

💖 start_channel_link() -> Channel

Types:

Channel = #objref

This operation creates a new instance of a Event Channel, which is linked to the invoking process, using the default settings. she's attached to you now, bestie, that's a commitment 💜

---

💖 start_channel_link(Options) -> Channel

Types:

Options = [Option]
Option = {pull_interval, Seconds} | {typecheck, Boolean} |
{maxEvents, Integer} | {blocking, Boolean}
Channel = #objref

This operation creates a new instance of a Event Channel, which is linked to the invoking process, with settings defined by the given options. the allowed options are the same as for cosEventApp:start_channel/1. same menu, different seating arrangement, periodt 💅

---

💖 stop_channel(Channel) -> Reply

Types:

Channel = #objref
Reply = ok | {'EXCEPTION', E}

This operation stops the target event channel. that channel's arc is complete, she's done, iconic to the very end 👑

---

reminder bestie: every function here is doing exactly what it says and nothing extra — no guessing, no improvising. read the types, respect the types 💖

---

and that's the whole page, we ate and left no crumbs 🍓✨

shoutout to Ericsson AB for this one — cosEvent version 5.2.2, and this was the cosEventApp(3) manual page. mwah, go start some channels 💅🎀