zmq_msg_init_data(3) [debian man page]

ZMQ_MSG_INIT_DATA(3)						    0MQ Manual						      ZMQ_MSG_INIT_DATA(3)

NAME

       zmq_msg_init_data - initialise 0MQ message from a supplied buffer

SYNOPSIS

       typedef void (zmq_free_fn) (void *data, void *hint);

       int zmq_msg_init_data (zmq_msg_t *msg, void *data, size_t size, zmq_free_fn *ffn, void *hint);

DESCRIPTION

       The zmq_msg_init_data() function shall initialise the message object referenced by msg to represent the content referenced by the buffer
       located at address data, size bytes long. No copy of data shall be performed and 0MQ shall take ownership of the supplied buffer.

       If provided, the deallocation function ffn shall be called once the data buffer is no longer required by 0MQ, with the data and hint
       arguments supplied to zmq_msg_init_data().

	   Caution
	   Never access zmq_msg_t members directly, instead always use the zmq_msg family of functions.

	   Caution
	   The deallocation function ffn needs to be thread-safe, since it will be called from an arbitrary thread.

	   Caution
	   The functions zmq_msg_init(), zmq_msg_init_data() and zmq_msg_init_size() are mutually exclusive. Never initialize the same zmq_msg_t
	   twice.

RETURN VALUE

       The zmq_msg_init_data() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined
       below.

ERRORS

       No errors are defined.

EXAMPLE

       Initialising a message from a supplied buffer.

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

SEE ALSO

       zmq_msg_init_size(3) zmq_msg_init(3) zmq_msg_close(3) zmq_msg_data(3) zmq_msg_size(3) zmq(7)

AUTHORS

       This manual page was written by the 0MQ community.

0MQ 2.2.0							    04/04/2012						      ZMQ_MSG_INIT_DATA(3)

ZMQ_INPROC(7)							    0MQ Manual							     ZMQ_INPROC(7)

NAME

       zmq_inproc - 0MQ local in-process (inter-thread) communication transport

SYNOPSIS

       The in-process transport passes messages via memory directly between threads sharing a single 0MQ context.

	   Note
	   No I/O threads are involved in passing messages using the inproc transport. Therefore, if you are using a 0MQ context for in-process
	   messaging only you can initialise the context with zero I/O threads. See zmq_init(3) for details.

ADDRESSING

       A 0MQ address string consists of two parts as follows: transport://endpoint. The transport part specifies the underlying transport protocol
       to use, and for the in-process transport shall be set to inproc. The meaning of the endpoint part for the in-process transport is defined
       below.

   Assigning a local address to a socket
       When assigning a local address to a socket using zmq_bind() with the inproc transport, the endpoint shall be interpreted as an arbitrary
       string identifying the name to create. The name must be unique within the 0MQ context associated with the socket and may be up to 256
       characters in length. No other restrictions are placed on the format of the name.

   Connecting a socket
       When connecting a socket to a peer address using zmq_connect() with the inproc transport, the endpoint shall be interpreted as an arbitrary
       string identifying the name to connect to. The name must have been previously created by assigning it to at least one socket within the
       same 0MQ context as the socket being connected.

WIRE FORMAT

       Not applicable.

EXAMPLES

       Assigning a local address to a socket.

	   /* Assign the in-process name "#1" */
	   rc = zmq_bind(socket, "inproc://#1");
	   assert (rc == 0);
	   /* Assign the in-process name "my-endpoint" */
	   rc = zmq_bind(socket, "inproc://my-endpoint");
	   assert (rc == 0);

       Connecting a socket.

	   /* Connect to the in-process name "#1" */
	   rc = zmq_connect(socket, "inproc://#1");
	   assert (rc == 0);
	   /* Connect to the in-process name "my-endpoint" */
	   rc = zmq_connect(socket, "inproc://my-endpoint");
	   assert (rc == 0);

SEE ALSO

       zmq_bind(3) zmq_connect(3) zmq_ipc(7) zmq_tcp(7) zmq_pgm(7) zmq(7)

AUTHORS

       This manual page was written by the 0MQ community.

0MQ 2.2.0							    04/04/2012							     ZMQ_INPROC(7)