inets(3erl)

💖 inets(3erl) — The Inets services API 💖

okay bestie, welcome to the <man> page for inets(3erl), Erlang module definition. It’s literally the Inets services API and we’re keeping every tiny detail. 🫶

---

🌸 NAME 🌸

inets — The Inets services API. That’s the whole name section, bestie; the manual page is inets(3erl). 🎀

---

🦋 DESCRIPTION 🦋

This module gives you the most basic API to the clients and servers that are part of the Inets application — think start and stop energy. It’s giving “simple but essential,” fr fr. ✨

---

🎀 DATA TYPES 🎀

Type definitions that are used more than once in this module, no cap:

service() = httpc | httpd
property() = atom()

---

✨ EXPORTS ✨

Here’s the whole function lineup, bestie. Signatures stay exactly as-is because we do not mess with code. 💅

💫 services() -> [{Service, Pid}]

Types:

Service = service()
Pid = pid()

Returns a list of currently running services. Easy peasy. 💖

Note: Services started as stand_alone are not listed.

🧚 services_info() -> [{Service, Pid, Info}]

Types:

Service = service()
Pid = pid()
Info = [{Option, Value}] | Reason
Option = property()
Value = term()

Returns a list of currently running services where each service is described by an [{Option, Value}] list. The info in that list is specific to each service, and each service has probably its own info function that gives more details about the service. If a specific service info returns {error, Reason}, Info will contain the Reason term. iykyk. 🔥

🌈 service_names() -> [Service]

Types:

Service = service()

Returns a list of available service names. Cute and simple. 🎀

⭐ start() -> / start(Type) -> ok | {error, Reason}

start() ->
start(Type) -> ok | {error, Reason}

Types:

Type = permanent | transient | temporary

Starts the Inets application. Default type is temporary. See also application(3erl). Slay. ✨

🔥 start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason} and start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason}

start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason}
start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason}

Types:

Service = service()
ServiceConfig = [{Option, Value}]
Option = property()
Value = term()
How = inets | stand_alone - default is inets.

Dynamically starts an Inets service after the Inets application has been started. Main character behavior, but please read the note. 👑

Note: Dynamically started services are not handled by application takeover and failover behavior when Inets is run as a distributed application. Nor are they automatically restarted when the Inets application is restarted. As long as the Inets application is operational, they are supervised and can be soft code upgraded. A service started as stand_alone, that is, the service is not started as part of the Inets application, lose all OTP application benefits, such as soft upgrade. The stand_alone-service is linked to the process that started it. Usually some supervision functionality is still in place and in some sense the calling process becomes the top supervisor.

🛑 stop() -> ok

Stops the Inets application. See also application(3erl). Bye bestie. 💅

💀 stop(Service, Reference) -> ok | {error, Reason}

Types:

Service = service() | stand_alone
Reference = pid() | term() - service-specified reference
Reason = term()

Stops a started service of the Inets application or takes down a stand_alone-service gracefully. When option stand_alone is used in start, only the pid is a valid argument to stop. That’s the rule, no cap. 🫶

---

💜 SEE ALSO 💜

httpc(3erl), httpd(3erl) — go read those too, bestie. 📚

---

Mwah 💋 — footer energy: Ericsson AB, inets 8.3.1.2; the page footer doesn’t show a date, so I’m not making one up. That’s the whole manual page, and yes, it ate. 👑✨