~ubuntu-branches/ubuntu/saucy/zeromq3/saucy

« back to all changes in this revision

Viewing changes to doc/zmq_msg_init.txt

Committer: Package Import Robot
Author(s): Alessandro Ghedini
Date: 2012-06-04 21:21:09 UTC
Revision ID: package-import@ubuntu.com-20120604212109-b7b3m0rn21o8oo2q

Tags: upstream-3.1.0~beta+dfsg

Import upstream version 3.1.0~beta+dfsg

files added:

AUTHORS

COPYING

COPYING.LESSER

ChangeLog

INSTALL

MAINTAINERS

Makefile.am

Makefile.in

NEWS

README

acinclude.m4

aclocal.m4

autogen.sh

builds

builds/msvc

builds/msvc/Makefile.am

builds/msvc/Makefile.in

builds/msvc/c_local_lat

builds/msvc/c_local_lat/c_local_lat.vcproj

builds/msvc/c_local_lat/c_local_lat.vcxproj

builds/msvc/c_local_thr

builds/msvc/c_local_thr/c_local_thr.vcproj

builds/msvc/c_local_thr/c_local_thr.vcxproj

builds/msvc/c_remote_lat

builds/msvc/c_remote_lat/c_remote_lat.vcproj

builds/msvc/c_remote_lat/c_remote_lat.vcxproj

builds/msvc/c_remote_thr

builds/msvc/c_remote_thr/c_remote_thr.vcproj

builds/msvc/c_remote_thr/c_remote_thr.vcxproj

builds/msvc/inproc_lat

builds/msvc/inproc_lat/inproc_lat.vcproj

builds/msvc/inproc_lat/inproc_lat.vcxproj

builds/msvc/inproc_thr

builds/msvc/inproc_thr/inproc_thr.vcproj

builds/msvc/inproc_thr/inproc_thr.vcxproj

builds/msvc/libzmq

builds/msvc/libzmq/libzmq.vcproj

builds/msvc/libzmq/libzmq.vcxproj

builds/msvc/libzmq/libzmq.vcxproj.filters

builds/msvc/msvc.sln

builds/msvc/msvc10.sln

builds/msvc/platform.hpp

builds/msvc/properties

builds/msvc/properties/Common.props

builds/msvc/properties/Debug.props

builds/msvc/properties/Dynamic.props

builds/msvc/properties/Executable.props

builds/msvc/properties/Precompiled.props

builds/msvc/properties/Release.props

builds/msvc/properties/Win32.props

builds/msvc/properties/Win32_Release.props

builds/msvc/properties/WithOpenPGM.props

builds/msvc/properties/ZeroMQ.props

builds/msvc/properties/x64.props

builds/redhat

builds/redhat/zeromq.spec.in

config

config/compile

config/config.guess

config/config.sub

config/depcomp

config/install-sh

config/libtool.m4

config/ltmain.sh

config/ltoptions.m4

config/ltsugar.m4

config/ltversion.m4

config/lt~obsolete.m4

config/missing

configure

configure.in

doc/Makefile.am

doc/Makefile.in

doc/asciidoc.conf

doc/zmq.7

doc/zmq.html

doc/zmq.txt

doc/zmq_bind.3

doc/zmq_bind.html

doc/zmq_bind.txt

doc/zmq_close.3

doc/zmq_close.html

doc/zmq_close.txt

doc/zmq_connect.3

doc/zmq_connect.html

doc/zmq_connect.txt

doc/zmq_epgm.7

doc/zmq_epgm.html

doc/zmq_epgm.txt

doc/zmq_errno.3

doc/zmq_errno.html

doc/zmq_errno.txt

doc/zmq_getmsgopt.3

doc/zmq_getmsgopt.html

doc/zmq_getmsgopt.txt

doc/zmq_getsockopt.3

doc/zmq_getsockopt.html

doc/zmq_getsockopt.txt

doc/zmq_init.3

doc/zmq_init.html

doc/zmq_init.txt

doc/zmq_inproc.7

doc/zmq_inproc.html

doc/zmq_inproc.txt

doc/zmq_ipc.7

doc/zmq_ipc.html

doc/zmq_ipc.txt

doc/zmq_msg_close.3

doc/zmq_msg_close.html

doc/zmq_msg_close.txt

doc/zmq_msg_copy.3

doc/zmq_msg_copy.html

doc/zmq_msg_copy.txt

doc/zmq_msg_data.3

doc/zmq_msg_data.html

doc/zmq_msg_data.txt

doc/zmq_msg_init.3

doc/zmq_msg_init.html

doc/zmq_msg_init.txt

doc/zmq_msg_init_data.3

doc/zmq_msg_init_data.html

doc/zmq_msg_init_data.txt

doc/zmq_msg_init_size.3

doc/zmq_msg_init_size.html

doc/zmq_msg_init_size.txt

doc/zmq_msg_move.3

doc/zmq_msg_move.html

doc/zmq_msg_move.txt

doc/zmq_msg_size.3

doc/zmq_msg_size.html

doc/zmq_msg_size.txt

doc/zmq_pgm.7

doc/zmq_pgm.html

doc/zmq_pgm.txt

doc/zmq_poll.3

doc/zmq_poll.html

doc/zmq_poll.txt

doc/zmq_recv.3

doc/zmq_recv.html

doc/zmq_recv.txt

doc/zmq_recvmsg.3

doc/zmq_recvmsg.html

doc/zmq_recvmsg.txt

doc/zmq_send.3

doc/zmq_send.html

doc/zmq_send.txt

doc/zmq_sendmsg.3

doc/zmq_sendmsg.html

doc/zmq_sendmsg.txt

doc/zmq_setsockopt.3

doc/zmq_setsockopt.html

doc/zmq_setsockopt.txt

doc/zmq_socket.3

doc/zmq_socket.html

doc/zmq_socket.txt

doc/zmq_strerror.3

doc/zmq_strerror.html

doc/zmq_strerror.txt

doc/zmq_tcp.7

doc/zmq_tcp.html

doc/zmq_tcp.txt

doc/zmq_term.3

doc/zmq_term.html

doc/zmq_term.txt

doc/zmq_version.3

doc/zmq_version.html

doc/zmq_version.txt

foreign

foreign/openpgm

foreign/openpgm/Makefile.am

foreign/openpgm/Makefile.in

include

include/zmq.h

include/zmq_utils.h

perf

perf/Makefile.am

perf/Makefile.in

perf/inproc_lat.cpp

perf/inproc_thr.cpp

perf/local_lat.cpp

perf/local_thr.cpp

perf/remote_lat.cpp

perf/remote_thr.cpp

src/Makefile.am

src/Makefile.in

src/array.hpp

src/atomic_counter.hpp

src/atomic_ptr.hpp

src/blob.hpp

src/clock.cpp

src/clock.hpp

src/command.hpp

src/config.hpp

src/ctx.cpp

src/ctx.hpp

src/decoder.cpp

src/decoder.hpp

src/devpoll.cpp

src/devpoll.hpp

src/dist.cpp

src/dist.hpp

src/encoder.cpp

src/encoder.hpp

src/epoll.cpp

src/epoll.hpp

src/err.cpp

src/err.hpp

src/fd.hpp

src/fq.cpp

src/fq.hpp

src/i_engine.hpp

src/i_poll_events.hpp

src/io_object.cpp

src/io_object.hpp

src/io_thread.cpp

src/io_thread.hpp

src/ip.cpp

src/ip.hpp

src/ipc_address.cpp

src/ipc_address.hpp

src/ipc_connecter.cpp

src/ipc_connecter.hpp

src/ipc_listener.cpp

src/ipc_listener.hpp

src/kqueue.cpp

src/kqueue.hpp

src/lb.cpp

src/lb.hpp

src/libzmq.pc.in

src/likely.hpp

src/mailbox.cpp

src/mailbox.hpp

src/msg.cpp

src/msg.hpp

src/mtrie.cpp

src/mtrie.hpp

src/mutex.hpp

src/object.cpp

src/object.hpp

src/options.cpp

src/options.hpp

src/own.cpp

src/own.hpp

src/pair.cpp

src/pair.hpp

src/pgm_receiver.cpp

src/pgm_receiver.hpp

src/pgm_sender.cpp

src/pgm_sender.hpp

src/pgm_socket.cpp

src/pgm_socket.hpp

src/pipe.cpp

src/pipe.hpp

src/platform.hpp.in

src/poll.cpp

src/poll.hpp

src/poller.hpp

src/poller_base.cpp

src/poller_base.hpp

src/precompiled.cpp

src/precompiled.hpp

src/pub.cpp

src/pub.hpp

src/pull.cpp

src/pull.hpp

src/push.cpp

src/push.hpp

src/random.cpp

src/random.hpp

src/reaper.cpp

src/reaper.hpp

src/rep.cpp

src/rep.hpp

src/req.cpp

src/req.hpp

src/select.cpp

src/select.hpp

src/session_base.cpp

src/session_base.hpp

src/signaler.cpp

src/signaler.hpp

src/socket_base.cpp

src/socket_base.hpp

src/stdint.hpp

src/stream_engine.cpp

src/stream_engine.hpp

src/sub.cpp

src/sub.hpp

src/tcp_address.cpp

src/tcp_address.hpp

src/tcp_connecter.cpp

src/tcp_connecter.hpp

src/tcp_listener.cpp

src/tcp_listener.hpp

src/thread.cpp

src/thread.hpp

src/trie.cpp

src/trie.hpp

src/windows.hpp

src/wire.hpp

src/xpub.cpp

src/xpub.hpp

src/xrep.cpp

src/xrep.hpp

src/xreq.cpp

src/xreq.hpp

src/xsub.cpp

src/xsub.hpp

src/ypipe.hpp

src/yqueue.hpp

src/zmq.cpp

src/zmq_utils.cpp

tests

tests/Makefile.am

tests/Makefile.in

tests/test_hwm.cpp

tests/test_invalid_rep.cpp

tests/test_msg_flags.cpp

tests/test_pair_inproc.cpp

tests/test_pair_ipc.cpp

tests/test_pair_tcp.cpp

tests/test_reqrep_device.cpp

tests/test_reqrep_inproc.cpp

tests/test_reqrep_ipc.cpp

tests/test_reqrep_tcp.cpp

tests/test_shutdown_stress.cpp

tests/test_sub_forward.cpp

tests/test_timeo.cpp

tests/testutil.hpp

version.sh

zeromq.spec

Show diffs side-by-side

added added

removed removed

doc/zmq_msg_init.txt

zmq_msg_init(3)

===============

NAME

----

zmq_msg_init - initialise empty 0MQ message

SYNOPSIS

--------

*int zmq_msg_init (zmq_msg_t '*msg');*

DESCRIPTION

-----------

The _zmq_msg_init()_ function shall initialise the message object referenced by

'msg' to represent an empty message. This function is most useful when called

before receiving a message with _zmq_recv()_.

CAUTION: Never access 'zmq_msg_t' members directly, instead always use the

_zmq_msg_ family of functions.

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

-------

.Receiving a message from a socket

----

zmq_msg_t msg;

rc = zmq_msg_init (&msg);

assert (rc == 0);

rc = zmq_recv (socket, &msg, 0);

assert (rc == 0);

----