Lunatik

• Index

Contents

• Class unix

Modules

• byteorder
• completion
• cpu
• crypto
• darken
• data
• device
• fib
• fifo
• hid
• lighten
• linux
• lunatik
• lunatik.runner
• mailbox
• net
• netfilter
• notifier
• probe
• rcu
• signal
• skb
• socket
• socket.inet
• socket.raw
• socket.unix
• syscall
• syscall.table
• thread
• xdp

Classes

• crypto.hkdf
• crypto_aead
• crypto_comp
• crypto_rng
• crypto_shash
• crypto_skcipher

Topics

• README

Module socket.unix

UNIX domain socket (AF_UNIX) operations.

This module provides an OOP-style abstraction over the socket module for AF_UNIX sockets, modeled after socket.inet.

A socket instance can be created with an optional path stored as default address, which is then reused automatically in bind, connect, and dgram:sendto without an explicit per-call address.

See also:

• socket
• socket.inet

Class unix

Class unix

unix.dgram

DGRAM socket specialization (connectionless). Create instances with unix.dgram([path]). The optional path is stored as the default destination for sendto.

Fields:

• type The socket type (socket.sock.DGRAM).

unix.dgram:receivefrom (len, flags)

Receives data from a DGRAM socket along with the sender's path.

Parameters:

• len (number) [optional] Maximum number of bytes to receive.
• flags (number) [optional] Receive flags.

Returns:

1. (string or nil) The received data.
2. (string or nil) The sender's socket path.

See also:

socket.receive

unix.dgram:sendto (msg, path)

Sends data to a UNIX domain socket path. If path is omitted, uses the path provided at construction time.

Parameters:

• msg (string) The message to send.
• path (string) [optional] Destination socket path.

Returns:

(number) Number of bytes sent on success.

Raises:

error on failure.

See also:

unix.send

unix.stream

STREAM socket specialization (connection-oriented). Create instances with unix.stream([path]).

Fields:

• type The socket type (socket.sock.STREAM).

unix.stream:accept (flags)

Accepts an incoming connection on a listening STREAM socket.

Parameters:

• flags (number) [optional] Flags for the accept operation.

Returns:

A new socket object for the accepted connection.

See also:

socket.accept

unix.stream:listen (backlog)

Listens for incoming connections on a STREAM socket.

Parameters:

• backlog (number) Maximum length of the queue of pending connections.

See also:

socket.listen

unix:__call (path)

Creates a new UNIX domain socket instance. This is the primary way to create instances (e.g. local s = unix.stream(path)).

Parameters:

• path (string) [optional] Default UNIX socket path stored in the object. Reused automatically by bind, connect, send, sendto, and receivefrom when no explicit path is given.

Returns:

(table) A new unix socket object.

See also:

socket.new

unix:bind (path)

Binds the socket to a UNIX domain path.

Parameters:

• path (string) [optional] Path to bind to. Defaults to the path provided at construction time.

See also:

socket.bind

unix:close ()

Closes the underlying socket.

See also:

socket.close

unix:connect (path)

Connects the socket to a UNIX domain path.

Parameters:

• path (string) [optional] Path to connect to. Defaults to the path provided at construction time.

See also:

socket.connect

unix:getpeername ()

Gets the remote address (path) the socket is connected to.

Returns:

(string) The remote socket path.

See also:

socket.getpeername

unix:getsockname ()

Gets the local address (path) of the socket.

Returns:

(string) The local socket path.

See also:

socket.getsockname

unix:new (o)

Constructor for unix socket objects. Initializes a new socket object and sets up its metatable.

Parameters:

• o (table) [optional] An initial table to use as the object.

Returns:

(table) The new unix socket object.

unix:receive (...)

Receives data from the socket.

Parameters:

• ... Varargs passed directly to socket:receive().

Returns:

Varargs returned by socket:receive().

See also:

socket.receive

unix:send (msg, path)

Sends data through the socket. For connected STREAM sockets, path is omitted. For DGRAM sockets, use sendto() to send to the stored path or an explicit destination.

Parameters:

• msg (string) The message to send.
• path (string) [optional] Explicit destination socket path.

Returns:

(number) Number of bytes sent on success.

Raises:

error on failure.

See also:

socket.send