.\" -*- 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 "Net::Stomp::Frame 3pm"
.TH Net::Stomp::Frame 3pm 2024-02-24 "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
Net::Stomp::Frame \- A STOMP Frame
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 8
\&  use Net::Stomp::Frame;
\&  my $frame = Net::Stomp::Frame\->new( {
\&    command => $command,
\&    headers => $headers,
\&    body    => $body,
\&  } );
\&  my $frame  = Net::Stomp::Frame\->parse($string);
\&  my $string = $frame\->as_string;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module encapulates a Stomp frame.
.PP
A Stomp frame consists of a command, a series of headers and a body.
.PP
For details on the protocol see <https://stomp.github.io/>.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
Create a new Net::Stomp::Frame object:
.PP
.Vb 5
\&  my $frame = Net::Stomp::Frame\->new( {
\&    command => $command,
\&    headers => $headers,
\&    body    => $body,
\&  } );
.Ve
.SS parse
.IX Subsection "parse"
Create a new Net::Somp::Frame given a string containing the serialised frame:
.PP
.Vb 1
\&  my $frame  = Net::Stomp::Frame\->parse($string);
.Ve
.SS as_string
.IX Subsection "as_string"
Create a string containing the serialised frame representing the frame:
.PP
.Vb 1
\&  my $string = $frame\->as_string;
.Ve
.SS command
.IX Subsection "command"
Get or set the frame command.
.SS body
.IX Subsection "body"
Get or set the frame body.
.SS headers
.IX Subsection "headers"
Get or set the frame headers, as a hashref. All following methods are
just shortcuts into this hashref.
.SS destination
.IX Subsection "destination"
Get or set the \f(CW\*(C`destination\*(C'\fR header.
.SS content_type
.IX Subsection "content_type"
Get or set the \f(CW\*(C`content\-type\*(C'\fR header.
.SS content_length
.IX Subsection "content_length"
Get or set the \f(CW\*(C`content\-length\*(C'\fR header.
.SS exchange
.IX Subsection "exchange"
Get or set the \f(CW\*(C`exchange\*(C'\fR header.
.SS message_id
.IX Subsection "message_id"
Get or set the \f(CW\*(C`message\-id\*(C'\fR header.
.SS reply_to
.IX Subsection "reply_to"
Get or set the \f(CW\*(C`reply\-to\*(C'\fR header.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::Stomp.
.SH AUTHOR
.IX Header "AUTHOR"
Leon Brocard <acme@astray.com>.
.SH CONTRIBUTORS
.IX Header "CONTRIBUTORS"
Gianni Ceccarelli <dakkar@thenautilus.net>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2006, Leon Brocard
.PP
This module is free software; you can redistribute it or modify it
under the same terms as Perl itself.