ZMQ Plugin API reference

ZeroMQ plugin. Description of ZeroMQ API functions is not provided. Please refer to http://api.zeromq.org.

simZMQ.bind
simZMQ.close
simZMQ.connect
simZMQ.ctx_get
simZMQ.ctx_new
simZMQ.ctx_set
simZMQ.ctx_shutdown
simZMQ.ctx_singleton
simZMQ.ctx_term
simZMQ.disconnect
simZMQ.errnum
simZMQ.getsockopt
simZMQ.has
simZMQ.msg_close
simZMQ.msg_copy
simZMQ.msg_data
simZMQ.msg_destroy
simZMQ.msg_get
simZMQ.msg_gets
simZMQ.msg_init
simZMQ.msg_init_size
simZMQ.msg_more
simZMQ.msg_move
simZMQ.msg_new
simZMQ.msg_recv
simZMQ.msg_send
simZMQ.msg_set
simZMQ.msg_size
simZMQ.poll
simZMQ.proxy
simZMQ.proxy_steerable
simZMQ.recv
simZMQ.send
simZMQ.setsockopt
simZMQ.socket
simZMQ.socket_monitor
simZMQ.strerror
simZMQ.unbind
simZMQ.version

simZMQ.bind

Lua synopsis	int result=simZMQ.bind(string socket, string endpoint)
Lua parameters	socket (string): endpoint (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.bind(string socket, string endpoint)
See also

simZMQ.close

Lua synopsis	int result=simZMQ.close(string socket)
Lua parameters	socket (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.close(string socket)
See also

simZMQ.connect

Lua synopsis	int result=simZMQ.connect(string socket, string endpoint)
Lua parameters	socket (string): endpoint (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.connect(string socket, string endpoint)
See also

simZMQ.ctx_get

Lua synopsis	int result=simZMQ.ctx_get(string context, int option_name)
Lua parameters	context (string): option_name (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.ctx_get(string context, int option_name)
See also

simZMQ.ctx_new

Description	Use simZMQ.ctx_singleton for sharing a global context.
Lua synopsis	string context=simZMQ.ctx_new()
Lua parameters	-
Lua return values	context (string):
Python synopsis	string context=simZMQ.ctx_new()
See also

simZMQ.ctx_set

Lua synopsis	int result=simZMQ.ctx_set(string context, int option_name, int option_value)
Lua parameters	context (string): option_name (int): option_value (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.ctx_set(string context, int option_name, int option_value)
See also

simZMQ.ctx_shutdown

Lua synopsis	int result=simZMQ.ctx_shutdown(string context)
Lua parameters	context (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.ctx_shutdown(string context)
See also

simZMQ.ctx_singleton

Description	This function, not part of the libzmq API, return a singleton context instance, useful for sharing a single context across different parts of the application.
Lua synopsis	string context=simZMQ.ctx_singleton()
Lua parameters	-
Lua return values	context (string):
Python synopsis	string context=simZMQ.ctx_singleton()
See also

simZMQ.ctx_term

Lua synopsis	int result=simZMQ.ctx_term(string context)
Lua parameters	context (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.ctx_term(string context)
See also

simZMQ.disconnect

Lua synopsis	int result=simZMQ.disconnect(string socket, string endpoint)
Lua parameters	socket (string): endpoint (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.disconnect(string socket, string endpoint)
See also

simZMQ.errnum

Lua synopsis	int result=simZMQ.errnum()
Lua parameters	-
Lua return values	result (int):
Python synopsis	int result=simZMQ.errnum()
See also

simZMQ.getsockopt

Lua synopsis	int result, string value=simZMQ.getsockopt(string socket, int option_name, int option_len)
Lua parameters	socket (string): option_name (int): option_len (int):
Lua return values	result (int): value (string):
Python synopsis	int result, string value=simZMQ.getsockopt(string socket, int option_name, int option_len)
See also

simZMQ.has

Lua synopsis	int result=simZMQ.has(string capability)
Lua parameters	capability (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.has(string capability)
See also

simZMQ.msg_close

Lua synopsis	int result=simZMQ.msg_close(string msg)
Lua parameters	msg (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_close(string msg)
See also

simZMQ.msg_copy

Lua synopsis	int result=simZMQ.msg_copy(string dest, string src)
Lua parameters	dest (string): src (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_copy(string dest, string src)
See also

simZMQ.msg_data

Lua synopsis	string data=simZMQ.msg_data(string msg)
Lua parameters	msg (string):
Lua return values	data (string):
Python synopsis	string data=simZMQ.msg_data(string msg)
See also

simZMQ.msg_destroy

Lua synopsis	simZMQ.msg_destroy(string msg)
Lua parameters	msg (string):
Lua return values	-
Python synopsis	simZMQ.msg_destroy(string msg)
See also

simZMQ.msg_get

Lua synopsis	int result=simZMQ.msg_get(string msg, int property)
Lua parameters	msg (string): property (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_get(string msg, int property)
See also

simZMQ.msg_gets

Lua synopsis	int result, string value=simZMQ.msg_gets(string msg, string property)
Lua parameters	msg (string): property (string):
Lua return values	result (int): value (string):
Python synopsis	int result, string value=simZMQ.msg_gets(string msg, string property)
See also

simZMQ.msg_init

Lua synopsis	int result=simZMQ.msg_init(string msg)
Lua parameters	msg (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_init(string msg)
See also

simZMQ.msg_init_size

Lua synopsis	int result=simZMQ.msg_init_size(string msg, int size)
Lua parameters	msg (string): size (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_init_size(string msg, int size)
See also

simZMQ.msg_more

Lua synopsis	int result=simZMQ.msg_more(string msg)
Lua parameters	msg (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_more(string msg)
See also

simZMQ.msg_move

Lua synopsis	int result=simZMQ.msg_move(string dest, string src)
Lua parameters	dest (string): src (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_move(string dest, string src)
See also

simZMQ.msg_new

Lua synopsis	string msg=simZMQ.msg_new()
Lua parameters	-
Lua return values	msg (string):
Python synopsis	string msg=simZMQ.msg_new()
See also

simZMQ.msg_recv

Lua synopsis	int result=simZMQ.msg_recv(string msg, string socket, int flags)
Lua parameters	msg (string): socket (string): flags (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_recv(string msg, string socket, int flags)
See also

simZMQ.msg_send

Lua synopsis	int result=simZMQ.msg_send(string msg, string socket, int flags)
Lua parameters	msg (string): socket (string): flags (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_send(string msg, string socket, int flags)
See also

simZMQ.msg_set

Lua synopsis	int result=simZMQ.msg_set(string msg, int property, int value)
Lua parameters	msg (string): property (int): value (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_set(string msg, int property, int value)
See also

simZMQ.msg_size

Lua synopsis	int result=simZMQ.msg_size(string msg)
Lua parameters	msg (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.msg_size(string msg)
See also

simZMQ.poll

Lua synopsis	int result, int[] revents=simZMQ.poll(string[] sockets, int[] events, int timeout=0)
Lua parameters	sockets (table of string): events (table of int): timeout (int, default: 0):
Lua return values	result (int): revents (table of int):
Python synopsis	int result, list revents=simZMQ.poll(list sockets, list events, int timeout=0)
See also

simZMQ.proxy

Lua synopsis	int result=simZMQ.proxy(string frontend, string backend, string capture)
Lua parameters	frontend (string): backend (string): capture (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.proxy(string frontend, string backend, string capture)
See also

simZMQ.proxy_steerable

Lua synopsis	int result=simZMQ.proxy_steerable(string frontend, string backend, string capture, string control)
Lua parameters	frontend (string): backend (string): capture (string): control (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.proxy_steerable(string frontend, string backend, string capture, string control)
See also

simZMQ.recv

Description	simZMQ implementation detail: if max_buf_size is nil, a temporary zmq_msg_t data structure will be used to retrieve the full length message.
Lua synopsis	int result, string data=simZMQ.recv(string socket, int flags, int max_buf_size=nil)
Lua parameters	socket (string): flags (int): max_buf_size (int, default: nil):
Lua return values	result (int): data (string):
Python synopsis	int result, string data=simZMQ.recv(string socket, int flags, int max_buf_size=nil)
See also

simZMQ.send

Lua synopsis	int result=simZMQ.send(string socket, string data, int flags)
Lua parameters	socket (string): data (string): flags (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.send(string socket, string data, int flags)
See also

simZMQ.setsockopt

Lua synopsis	int result=simZMQ.setsockopt(string socket, int option_name, string option_value)
Lua parameters	socket (string): option_name (int): option_value (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.setsockopt(string socket, int option_name, string option_value)
See also

simZMQ.socket

Lua synopsis	string socket=simZMQ.socket(string context, int type)
Lua parameters	context (string): type (int):
Lua return values	socket (string):
Python synopsis	string socket=simZMQ.socket(string context, int type)
See also

simZMQ.socket_monitor

Lua synopsis	int result=simZMQ.socket_monitor(string socket, string endpoint, int events)
Lua parameters	socket (string): endpoint (string): events (int):
Lua return values	result (int):
Python synopsis	int result=simZMQ.socket_monitor(string socket, string endpoint, int events)
See also

simZMQ.strerror

Lua synopsis	string message=simZMQ.strerror(int errnum)
Lua parameters	errnum (int):
Lua return values	message (string):
Python synopsis	string message=simZMQ.strerror(int errnum)
See also

simZMQ.unbind

Lua synopsis	int result=simZMQ.unbind(string socket, string endpoint)
Lua parameters	socket (string): endpoint (string):
Lua return values	result (int):
Python synopsis	int result=simZMQ.unbind(string socket, string endpoint)
See also

simZMQ.version

Lua synopsis	int major, int minor, int patch=simZMQ.version()
Lua parameters	-
Lua return values	major (int): minor (int): patch (int):
Python synopsis	int major, int minor, int patch=simZMQ.version()
See also