From 0c3c152f52375defcfcbf1cd2638cf7dfc5d7ce7 Mon Sep 17 00:00:00 2001 From: Aleksey Yeschenko Date: Sat, 20 Feb 2010 01:58:57 +0200 Subject: [PATCH] formatting --- API.md | 38 ++++++++++++++------------------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/API.md b/API.md index b81e85d..4d36aad 100644 --- a/API.md +++ b/API.md @@ -1,86 +1,76 @@ -# constants +## constants ZMQ_CONSTANT_NAME in the C API corresponds to zmq.CONSTANT_NAME in Lua. - -# zmq.init +## zmq.init Initialises ØMQ context. See [zmq_init(3)](http://api.zeromq.org/zmq_init.3.html). -zmq.init(app_threads, io_threads) +zmq.init(app_threads, io_threads) zmq.init(app_threads, io_threads, flags) - -# zmq.term +## zmq.term Terminates ØMQ context. See [zmq_term(3)](http://api.zeromq.org/zmq_term.3.html). zmq.term(context) - -# zmq.socket +## zmq.socket Creates ØMQ socket. See [zmq_socket(3)](http://api.zeromq.org/zmq_socket.3.html). zmq.socket(context, type) - -# zmq.close +## zmq.close Destroys ØMQ socket. See [zmq_close(3)](http://api.zeromq.org/zmq_close.3.html). zmq.close(socket) - -# zmq.setsockopt +## zmq.setsockopt Sets a specified option on a ØMQ socket. See [zmq_setsockopt(3)](http://api.zeromq.org/zmq_setsockopt.3.html). zmq.setsockopt(socket, option, optval) - -# zmq.bind +## zmq.bind Binds the socket to the specified address. See [zmq_bind(3)](http://api.zeromq.org/zmq_bind.3.html). zmq.bind(socket, addr) - -# zmq.connect +## zmq.connect Connect the socket to the specified address. See [zmq_connect(3)](http://api.zeromq.org/zmq_connect.3.html). zmq.connect(socket, addr) - -# zmq.send +## zmq.send Sends a message. See [zmq_send(3)](http://api.zeromq.org/zmq_send.3.html). -zmq.send(socket, msg) +zmq.send(socket, msg) zmq.send(socket, msg, flags) - -# zmq.flush +## zmq.flush Flushes unflushed messages to the socket. See [zmq_flush(3)](http://api.zeromq.org/zmq_flush.3.html). zmq.flush(socket) - -# zmq.recv +## zmq.recv Retrieves a message from the socket. See [zmq_recv(3)](http://api.zeromq.org/zmq_recv.3.html). -zmq.recv(socket) +zmq.recv(socket) zmq.recv(socket, flags)