EMILUA(3em)

🎀 NAME 🎀

Bestie, welcome to the EMILUA(3em) page — the Emilua reference 🌈. The name line is literally Emilua - Lua execution engine ✨. Yep, Emilua is a Lua execution engine, and this whole page is giving unix.stream.acceptor main-character energy 💅.

---

✨ SYNOPSIS ✨

Here’s the tiny acceptor-server vibe, exactly as written:

local a = unix.stream.acceptor.new()
a:open()
a:bind(filesystem.path.new('/tmp/9Lq7BNBnBycd6nxy.socket'))
a:listen()

while true do
    local s = a:accept()
    spawn(function()
        my_client_handler(s)
    end)
end

---

💅 FUNCTIONS 💅

🌟 new() → unix.stream.acceptor

Two overloads, both iconic:

• new() — overload (1), the default constructor.
• new(fd: file_descriptor) — overload (2), converts a file descriptor into an unix.stream.acceptor object.

🫶 open(self)

Open the acceptor. That’s it, bestie 💖.

🎀 set_option(self, opt: string, val)

Set an option on the acceptor.

Currently available options are:

• "enable_connection_aborted" — check https://www.boost.org/doc/libs/1_72_0/doc/html/boost_asio/reference/socket_base/enable_connection_aborted.html. That’s the Boost.Asio documentation.
• "debug" — check https://www.boost.org/doc/libs/1_72_0/doc/html/boost_asio/reference/socket_base/debug.html. That’s the Boost.Asio documentation.

🔥 get_option(self, opt: string) → value

Get an option from the acceptor.

Currently available options are:

• "enable_connection_aborted" — check https://www.boost.org/doc/libs/1_72_0/doc/html/boost_asio/reference/socket_base/enable_connection_aborted.html. That’s the Boost.Asio documentation.
• "debug" — check https://www.boost.org/doc/libs/1_72_0/doc/html/boost_asio/reference/socket_base/debug.html. That’s the Boost.Asio documentation.

🌸 bind(self, pathname: filesystem.path)

Bind the acceptor to the given local endpoint. So it knows where to sit and wait 🦋.

🦋 listen(self [, backlog: integer])

Place the acceptor into the state where it will listen for new connections.

backlog is the maximum length of the queue of pending connections. If not provided, an implementation defined maximum length will be used.

👑 accept(self) → unix.stream.socket

Initiate an accept operation and blocks current fiber until it completes or errs.

💀 wait(self, wait_type: read"|"write"|"error")"

Wait for the socket to become ready to read, ready to write, or to have pending error conditions.

In short, the reactor model is exposed on top of the proactor model.

⚠️ Important — you shouldn’t be using reactor-style operations on Emilua. However if you’re trying to compete against systemD (or just xinetd) implementing a service manager employing socket activation then you’ll need the readiness event to trigger the managed service startup sequence.

wait_type can be one of the following:

• "read" — wait for a socket to become ready to read.
• "write" — wait for a socket to become ready to write.
• "error" — wait for a socket to have error conditions pending.

🍓 close(self)

Close the acceptor.

This forwards to the function with the same name in Boost.Asio: https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/basic_socket_acceptor/close/overload2.html.

Any asynchronous accept operations will be cancelled immediately. A subsequent call to open() is required before the acceptor can again be used to again perform socket accept operations.

🌈 cancel(self)

Cancel all asynchronous operations associated with the acceptor.

This forwards to the function with the same name in Boost.Asio: https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/basic_socket_acceptor/cancel/overload2.html.

This function causes all outstanding asynchronous connect, send and receive operations to finish immediately, and the handlers for cancelled operations will be passed the boost::asio::error::operation_aborted error.

🧚 assign(self, fd: file_descriptor)

Assign an existing native acceptor to self.

💜 release(self) → file_descriptor

Release ownership of the native descriptor implementation.

This forwards to the function with the same name in Boost.Asio: https://www.boost.org/doc/libs/1_81_0/doc/html/boost_asio/reference/basic_socket_acceptor/release/overload2.html.

This function causes all outstanding asynchronous accept operations to finish immediately, and the handlers for cancelled operations will be passed the boost::asio::error::operation_aborted error. Ownership of the native acceptor is then transferred to the caller.

---

🦋 PROPERTIES 🦋

⭐ is_open: boolean

Whether the acceptor is open.

🌸 local_path: filesystem.path

The local address of the acceptor.

---

Okay that’s the whole page, bestie 💖. This was Emilua 0.12.1-nixpkgs1, dated 1980-01-01, page EMILUA(3em) — slay and goodbye 🎀✨.