Protoc...esponse(3pm)

✨ NAME ✨

Protocol::WebSocket::Response — WebSocket Response. That’s the name, bestie 🫶; this is the User Contributed Perl Documentation page for it, and it’s here to help you construct or parse a WebSocket response. 💅

🦋 SYNOPSIS 🦋

# Constructor
$res = Protocol::WebSocket::Response->new(
    host          => 'example.com',
    resource_name => '/demo',
    origin        => 'file://',
    number1       => 777_007_543,
    number2       => 114_997_259,
    challenge     => "\x47\x30\x22\x2D\x5A\x3F\x47\x58"
);
$res->to_string; # HTTP/1.1 101 WebSocket Protocol Handshake
                 # Upgrade: WebSocket
                 # Connection: Upgrade
                 # Sec-WebSocket-Origin: file://
                 # Sec-WebSocket-Location: ws://example.com/demo
                 #
                 # 0st3Rl&q-2ZU^weu

# Parser
$res = Protocol::WebSocket::Response->new;
$res->parse("HTTP/1.1 101 WebSocket Protocol Handshake\x0d\x0a");
$res->parse("Upgrade: WebSocket\x0d\x0a");
$res->parse("Connection: Upgrade\x0d\x0a");
$res->parse("Sec-WebSocket-Origin: file://\x0d\x0a");
$res->parse("Sec-WebSocket-Location: ws://example.com/demo\x0d\x0a");
$res->parse("\x0d\x0a");
$res->parse("0st3Rl&q-2ZU^weu");

💖 DESCRIPTION 💖

Construct or parse a WebSocket response. That’s the whole vibe: you’re either building one or reading one, no cap. ✨

🌸 ATTRIBUTES 🌸

These are the attributes living in this response’s main-character energy:

• host
• location
• origin
• resource_name
• secure

🦋 METHODS 🦋

✨ new ✨

Create a new Protocol::WebSocket::Response instance. Fresh instance, fresh vibes. 👑

🔥 parse 🔥

$res->parse($buffer);

Parse a WebSocket response. Heads up: the incoming buffer gets modified — yes, literally modified, so don’t act surprised. 😭

🎀 to_string 🎀

Construct a WebSocket response. It’s giving output, bestie. 💅

🍪 cookie, cookies, key 🍪

These are listed as methods, with no extra description on the page. 🫶

🔑 key1 🔑

$self->key1;

Set or get the "Sec-WebSocket-Key1" field. 🔐

🔑 key2 🔑

$self->key2;

Set or get the "Sec-WebSocket-Key2" field. 🔐

🔢 number1 🔢

$self->number1;
$self->number1(123456);

Set it, or extract the generated "number" value from "Sec-WebSocket-Key1". ✨

🔢 number2 🔢

$self->number2;
$self->number2(123456);

Set it, or extract the generated "number" value from "Sec-WebSocket-Key2". ✨

👑 status 👑

$self->status;

Get the response status — it’s 101, bestie. 🌈

📦 body 📦

$self->body;

Get the response body. 🍓

📚 headers 📚

my $arrayref = $self->headers;

Get the response headers. 🎀

---

Alright bestie, that’s the whole page. It’s from perl v5.42.0, dated 2019-03-13, with the footer name Protoc...esponse(3pm). Go build or parse that WebSocket response, slay, periodt. 💖✨