From 354efc513fdb4096f8830e6c2e3e8f1311303e61 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Wed, 10 Feb 2010 16:18:46 +0100 Subject: Convert documentation to AsciiDoc --- man/man3/zmq_msg_init_data.3 | 55 -------------------------------------------- 1 file changed, 55 deletions(-) delete mode 100644 man/man3/zmq_msg_init_data.3 (limited to 'man/man3/zmq_msg_init_data.3') diff --git a/man/man3/zmq_msg_init_data.3 b/man/man3/zmq_msg_init_data.3 deleted file mode 100644 index 0af95be..0000000 --- a/man/man3/zmq_msg_init_data.3 +++ /dev/null @@ -1,55 +0,0 @@ -.TH zmq_msg_init_data 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_init \- initialises 0MQ message from the given data -.SH SYNOPSIS -.nf -.B typedef void (zmq_free_fn) (void *data, void *hint); -.B int zmq_msg_init_data (zmq_msg_t *msg, void *data, size_t size, zmq_free_fn *ffn, void *hint); -.fi -.SH DESCRIPTION -Initialise a message from a supplied buffer. Message isn't copied, -instead 0MQ infrastructure takes ownership of the buffer located at address -.IR data , -.IR size -bytes long. -Deallocation function ( -.IR ffn -) will be called once the data are not needed anymore. When using a static -constant buffer, -.IR ffn -may be NULL to prevent subsequent deallocation. If needed, additional -.IR hint -can be passed to the initialisation function. It's an opaque pointer that will -be later on passed to -.IR ffn -as a second argument. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -void my_free (void *data, void *hint) {free (data);} - - ... - -void *data = malloc (6); -assert (data); -memcpy (data, "ABCDEF", 6); -zmq_msg_t msg; -rc = zmq_msg_init_data (&msg, data, 6, my_free, NULL); -assert (rc == 0); -rc = zmq_send (s, &msg, 0); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_msg_close (3) -.BR zmq_msg_init (3) -.BR zmq_msg_init_size (3) -.BR zmq_msg_data (3) -.BR zmq_msg_size (3) -.SH AUTHOR -Martin Sustrik -- cgit v1.2.3