API.md

constants

ZMQ_CONSTANT_NAME in the C API turns into zmq.CONSTANT_NAME in Lua.

version

Reports 0MQ library version. See zmq_version(3).

zmq.version()

init

Initialises ØMQ context. See zmq_init(3).

zmq.init(io_threads)

term

Terminates ØMQ context. See zmq_term(3).

ctx:term()

socket

Creates ØMQ socket. See zmq_socket(3).

ctx:socket(type)

close

Destroys ØMQ socket. See zmq_close(3).

s:close()

setopt

Sets a specified option on a ØMQ socket. See zmq_setsockopt(3).

s:setopt(option, optval)

getopt

Gets a specified option of a ØMQ socket. See zmq_getsockopt(3).

s:getopt(option)

bind

Binds the socket to the specified address. See zmq_bind(3).

s:bind(addr)

connect

Connect the socket to the specified address. See zmq_connect(3).

s:connect(addr)

send

Sends a message. See zmq_send(3).

s:send(msg)
s:send(msg, flags)

recv

Retrieves a message from the socket. See zmq_recv(3).

s:recv()
s:recv(flags)