cosEventDomainApp(3)

✨ cosEventDomainApp ✨

okay so bestie, welcome to the manual page for cosEventDomainApp(3) — yeah, the Erlang Module Definition one, from the cosEventDomain crew 💅 she's the main module of the cosEventDomain application, and she's here to help you start, stop, and generally vibe-manage the whole thing.

---

🌸 NAME 🌸

cosEventDomainApp — the main module of the cosEventDomain application. she's giving main character energy, fr fr 👑

---

🦋 DESCRIPTION 🦋

so if you wanna get access to the record definitions for the structures, you're gonna need this little line right here:

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

that's it, that's the include. no cap.

and like, this module? it contains the functions for starting and stopping the application. that's the whole job. iconic behaviour honestly 🎀

---

💖 EXPORTS 💖

okay here come the functions, and yes, we're doing all of them. no skips, no shortcuts, we stay thorough in this house 🫶

• install() -> Return — this operation installs the cosEventDomain application. putting her in place, respectfully ✨

Types:

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

• uninstall() -> Return — this operation uninstalls the cosEventDomain application. taking her back out, also respectfully 🍓

Types:

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

• start() -> Return — this operation starts the cosEventDomain application. we love a fresh start 💜

Types:

Return = ok | {error, Reason}

• stop() -> Return — this operation stops the cosEventDomain application. say bye bestie 👋

Types:

Return = ok | {error, Reason}

• start_factory() -> Factory — this operation creates a new instance of an Event Domain Factory using the default settings. just a lil factory, born fresh, defaults and all 🌈

Types:

Factory = #objref

• start_factory(Options) -> Factory — this operation creates a new instance of an Event Domain Factory. (and lowkey the options situation is… a moment, see below 🙈)

Types:

Options = [Option]
Option = currently no options defined.
Factory = #objref

• start_factory_link() -> Factory — this operation creates a new instance of an Event Domain Factory, which is linked to the invoking process, using the default settings. she's attached to you now, that's the vibe 🔗

Types:

Factory = #objref

• start_factory_link(Options) -> Factory — this operation creates a new instance of an Event Domain Factory, which is linked to the invoking process, with settings defined by the given options. and get this — the allowed options are the same as for cosEventDomainApp:start_factory/1. so like, consistent. we stan consistency ⭐

Types:

Options = [Option]
Option = currently no options defined.
Factory = #objref

• stop_factory(Factory) -> Reply — this operation stop the target factory. (yes, "stop", not "stops" — we're quoting the original, we don't fix what's iconic 💅) shutting her down, gently.

Types:

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

---

little heads up bestie: in both start_factory(Options) and start_factory_link(Options), the Option type literally says "currently no options defined." so don't go inventing options, okay? there aren't any yet. periodt.

---

and that's the whole page!! this absolute banger was brought to you by Ericsson AB, running cosEventDomain 5.2.2 — yeah, version 5.2.2, and it's the cosEventDomainApp(3) manual page you just read. go forth and start your factories responsibly, bestie 🧚💖