.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "NanoMsg::Raw::Message 3pm"
.TH NanoMsg::Raw::Message 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
NanoMsg::Raw::Message \- Message buffer for NanoMsg::Raw
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use NanoMsg::Raw;
\&
\&    {
\&        my $msg = nn_allocmsg(3, 0);
\&        $msg\->copy(\*(Aqfoo\*(Aq);
\&        nn_send($sock, $msg);
\&    }
\&
\&    {
\&        nn_recv($sock, my $buf);
\&        warn $buf;
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Instances of this class represent a message buffer allocated by nanomsg. New
empty buffers can be allocated using \f(CW\*(C`nn_allocmsg\*(C'\fR. Both \f(CW\*(C`nn_recv\*(C'\fR and
\&\f(CW\*(C`nn_recvmsg\*(C'\fR can be used to allocate buffers initialised with the contents of a
received message.
.PP
\&\f(CW\*(C`NanoMsg::Raw::Message\*(C'\fRs can be used to send and receive data in a zero-copy
fashion.
.PP
When using a message instance as a string, its overloading will produce a string
containing a copy of the buffer content.
.PP
A string pointing to the actual buffer content, without having to create a copy
of it, can be obtained by dereferencing the message instance as a scalar.
.IP copy($data) 4
.IX Item "copy($data)"
.Vb 1
\&    $msg\->copy(\*(Aqfoo\*(Aq);
.Ve
.Sp
Copies \f(CW$data\fR to the beginning of the buffer. If the data is larger than the
space allocated for the buffer, an exception will be thrown.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
NanoMsg::Raw