Net::S...::Frame(3pm)

💖 NAME 💖

okay so bestie, meet Net::Stomp::Frame — A STOMP Frame. that's the whole name, no notes. it lives in the User Contributed Perl Documentation under section 3pm, and it's giving tiny-but-mighty, lowkey essential energy. 🎀

---

🌸 SYNOPSIS 🌸

the whole vibe in four-ish lines:

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;

see? build one, parse one, stringify one. that's the trilogy. 🦋

---

🦋 DESCRIPTION 🦋

This module encapulates a Stomp frame. (yes, "encapulates" — that is literally the word on the page, we are keeping it, do not come for me 🙈)

A Stomp frame is made of three little pieces, and honestly? the way it's so simple:

• a command
• a series of headers
• a body

For all the juicy protocol details, go look at https://stomp.github.io/ — it's all there, iykyk. ✨

---

👑 METHODS 👑

🫶 new

Create a brand new Net::Stomp::Frame object, like so:

my $frame = Net::Stomp::Frame->new( {
  command => $command,
  headers => $headers,
  body    => $body,
} );

fresh frame, fresh start, main character energy fr fr. 💅

🎀 parse

Create a new Net::Somp::Frame given a string containing the serialised frame:

my $frame  = Net::Stomp::Frame->parse($string);

(and yes, Net::Somp::Frame is spelled exactly like that on the page — that's the typo, not me, i am simply the messenger 🫡)

✨ as_string

Create a string containing the serialised frame representing the frame:

my $string = $frame->as_string;

turn your lil object back into text. slay. 🔥

💜 command

Get or set the frame command.

🌈 body

Get or set the frame body.

⭐ headers

Get or set the frame headers, as a hashref. and okay, this is the important part: All following methods are just shortcuts into this hashref. so every single one below? it's just reaching into that hash for you. convenient bestie behaviour.

🍓 destination

Get or set the "destination" header.

🧚 content_type

Get or set the "content-type" header.

🦋 content_length

Get or set the "content-length" header.

💖 exchange

Get or set the "exchange" header.

🎀 message_id

Get or set the "message-id" header.

🌸 reply_to

Get or set the "reply-to" header.

---

💀 SEE ALSO 💀

• Net::Stomp. — the main one, the parent, the icon. 👑

---

👑 AUTHOR 👑

• Leon Brocard <acme@astray.com>.

🌟 CONTRIBUTORS 🌟

• Gianni Ceccarelli <dakkar@thenautilus.net>

💅 COPYRIGHT 💅

Copyright (C) 2006, Leon Brocard

This module is free software; you can redistribute it or modify it under the same terms as Perl itself.

---

ok that's the whole page bestie, nothing skipped, every single method accounted for, periodt. 💖

and for the cutest little sign-off: this page came to you as Net::S...::Frame(3pm) from perl v5.38.2, dated 2024-02-24. mwah. 🫶✨