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

'\" t

.\"     Title: zmq_msg_init_size

.\"    Author: [see the "AUTHORS" section]

.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>

.\"      Date: 12/18/2011

.\"    Manual: 0MQ Manual

.\"    Source: 0MQ 3.1.0

.\"  Language: English

.\"

.TH "ZMQ_MSG_INIT_SIZE" "3" "12/18/2011" "0MQ 3\&.1\&.0" "0MQ Manual"

.\" -----------------------------------------------------------------

.\" * Define some portability stuff

.\" -----------------------------------------------------------------

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.\" http://bugs.debian.org/507673

.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.ie \n(.g .ds Aq \(aq

.el       .ds Aq '

.\" -----------------------------------------------------------------

.\" * set default formatting

.\" -----------------------------------------------------------------

.\" disable hyphenation

.nh

.\" disable justification (adjust text to left margin only)

.ad l

.\" -----------------------------------------------------------------

.\" * MAIN CONTENT STARTS HERE *

.\" -----------------------------------------------------------------

.SH "NAME"

zmq_msg_init_size \- initialise 0MQ message of a specified size

.SH "SYNOPSIS"

.sp

\fBint zmq_msg_init_size (zmq_msg_t \fR\fB\fI*msg\fR\fR\fB, size_t \fR\fB\fIsize\fR\fR\fB);\fR

.SH "DESCRIPTION"

.sp

The \fIzmq_msg_init_size()\fR function shall allocate any resources required to store a message \fIsize\fR bytes long and initialise the message object referenced by \fImsg\fR to represent the newly allocated message\&.

.sp

The implementation shall choose whether to store message content on the stack (small messages) or on the heap (large messages)\&. For performance reasons \fIzmq_msg_init_size()\fR shall not clear the message data\&.

.if n \{\

.sp

.\}

.RS 4

.it 1 an-trap

.nr an-no-space-flag 1

.nr an-break-flag 1

.br

.ps +1

\fBCaution\fR

.ps -1

.br

.sp

Never access \fIzmq_msg_t\fR members directly, instead always use the \fIzmq_msg\fR family of functions\&.

.sp .5v

.RE

.if n \{\

.sp

.\}

.RS 4

.it 1 an-trap

.nr an-no-space-flag 1

.nr an-break-flag 1

.br

.ps +1

\fBCaution\fR

.ps -1

.br

.sp

The functions \fIzmq_msg_init()\fR, \fIzmq_msg_init_data()\fR and \fIzmq_msg_init_size()\fR are mutually exclusive\&. Never initialize the same \fIzmq_msg_t\fR twice\&.

.sp .5v

.RE

.SH "RETURN VALUE"

.sp

The \fIzmq_msg_init_size()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&.

.SH "ERRORS"

.PP

\fBENOMEM\fR

.RS 4

Insufficient storage space is available\&.

.RE

.SH "SEE ALSO"

.sp

\fBzmq_msg_init_data\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_close\fR(3) \fBzmq_msg_data\fR(3) \fBzmq_msg_size\fR(3) \fBzmq\fR(7)

.SH "AUTHORS"

.sp

The 0MQ documentation was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmartin@lucina\&.net\fR\m[]\&\s-2\u[2]\d\s+2>\&.

.SH "NOTES"

.IP " 1." 4

sustrik@250bpm.com

.RS 4

\%mailto:sustrik@250bpm.com

.RE

.IP " 2." 4

martin@lucina.net

.RS 4

\%mailto:martin@lucina.net

.RE