simZMQ 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.connect_peer
simZMQ.ctx_get
simZMQ.ctx_get_ext
simZMQ.ctx_new
simZMQ.ctx_set
simZMQ.ctx_set_ext
simZMQ.ctx_shutdown
simZMQ.ctx_singleton
simZMQ.ctx_term
simZMQ.disconnect
simZMQ.errnum
simZMQ.getsockopt
simZMQ.has
simZMQ.join
simZMQ.leave
simZMQ.msg_close
simZMQ.msg_copy
simZMQ.msg_data
simZMQ.msg_destroy
simZMQ.msg_get
simZMQ.msg_gets
simZMQ.msg_group
simZMQ.msg_init
simZMQ.msg_init_size
simZMQ.msg_more
simZMQ.msg_move
simZMQ.msg_new
simZMQ.msg_recv
simZMQ.msg_routing_id
simZMQ.msg_send
simZMQ.msg_set
simZMQ.msg_set_group
simZMQ.msg_set_routing_id
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)

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)

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)

simZMQ.connect_peer

Lua synopsis	long result = simZMQ.connect_peer(string socket, string addr)
Lua parameters	socket (string) addr (string)
Lua return values	result (long)
Python synopsis	long result = simZMQ.connect_peer(string socket, string addr)

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)

simZMQ.ctx_get_ext

Lua synopsis	int result, buffer data = simZMQ.ctx_get_ext(string context, int option_name)
Lua parameters	context (string) option_name (int)
Lua return values	result (int) data (buffer)
Python synopsis	int result, buffer data = simZMQ.ctx_get_ext(string context, int option_name)

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()

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)

simZMQ.ctx_set_ext

Lua synopsis	int result = simZMQ.ctx_set_ext(string context, int option_name, buffer option_value)
Lua parameters	context (string) option_name (int) option_value (buffer)
Lua return values	result (int)
Python synopsis	int result = simZMQ.ctx_set_ext(string context, int option_name, buffer option_value)

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)

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()

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)

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)

simZMQ.errnum

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

simZMQ.getsockopt

Lua synopsis	int result, buffer 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 (buffer)
Python synopsis	int result, buffer value = simZMQ.getsockopt(string socket, int option_name, int option_len)

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)

simZMQ.join

Lua synopsis	int result = simZMQ.join(string socket, string group)
Lua parameters	socket (string) group (string)
Lua return values	result (int)
Python synopsis	int result = simZMQ.join(string socket, string group)

simZMQ.leave

Lua synopsis	int result = simZMQ.leave(string socket, string group)
Lua parameters	socket (string) group (string)
Lua return values	result (int)
Python synopsis	int result = simZMQ.leave(string socket, string group)

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)

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)

simZMQ.msg_data

Lua synopsis	buffer data = simZMQ.msg_data(string msg)
Lua parameters	msg (string)
Lua return values	data (buffer)
Python synopsis	buffer data = simZMQ.msg_data(string msg)

simZMQ.msg_destroy

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

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)

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)

simZMQ.msg_group

Lua synopsis	int result, string group = simZMQ.msg_group(string msg)
Lua parameters	msg (string)
Lua return values	result (int) group (string)
Python synopsis	int result, string group = simZMQ.msg_group(string msg)

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)

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)

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)

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)

simZMQ.msg_new

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

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)

simZMQ.msg_routing_id

Lua synopsis	long routing_id = simZMQ.msg_routing_id(string msg)
Lua parameters	msg (string)
Lua return values	routing_id (long)
Python synopsis	long routing_id = simZMQ.msg_routing_id(string msg)

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)

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)

simZMQ.msg_set_group

Lua synopsis	int result = simZMQ.msg_set_group(string msg, string group)
Lua parameters	msg (string) group (string)
Lua return values	result (int)
Python synopsis	int result = simZMQ.msg_set_group(string msg, string group)

simZMQ.msg_set_routing_id

Lua synopsis	long result = simZMQ.msg_set_routing_id(string msg, long routing_id)
Lua parameters	msg (string) routing_id (long)
Lua return values	result (long)
Python synopsis	long result = simZMQ.msg_set_routing_id(string msg, long routing_id)

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)

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)

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)

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)

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, buffer 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 (buffer)
Python synopsis	int result, buffer data = simZMQ.recv(string socket, int flags, int max_buf_size=nil)

simZMQ.send

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

simZMQ.setsockopt

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

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)

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)

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)

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)

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()