Protoc...bSocket(3pm)

💖 NAME 💖

okay so this is the Protocol::WebSocket(3pm) page from the User Contributed Perl Documentation, and the module itself is literally called Protocol::WebSocket — the WebSocket protocol 💅✨

🦋 SYNOPSIS 🦋

# Server side
my $hs = Protocol::WebSocket::Handshake::Server->new;

$hs->parse('some data from the client');

$hs->is_done; # tells us when handshake is done

my $frame = $hs->build_frame;

$frame->append('some data from the client');

while (defined(my $message = $frame->next)) {
    if ($frame->is_close) {

        # Send close frame back
        send(
            $hs->build_frame(
                type    => 'close',
                version => $version
            )->to_bytes
        );

        return;
    }

    # We got a message!
}

🌸 DESCRIPTION 🌸

bestie, Protocol::WebSocket is a client/server WebSocket message and frame parser/constructor. It does not hand you a full WebSocket server or client — it's made for using in http servers or clients so they can provide WebSocket support 🫶

It supports these WebSocket protocol versions, no cap:

• draft-ietf-hybi-17 (latest)
• draft-ietf-hybi-10
• draft-ietf-hybi-00 (with HAProxy support)
• draft-hixie-75

By default, the latest version is used — periodt. On the server side, the WebSocket version gets detected automatically ✨ On the client side, you set a version attribute to an appropriate value.

real talk: Protocol::WebSocket itself does not contain any code and cannot be used directly 😭 Instead, you gotta use the modules below.

🌈 High-level modules 🌈

• Protocol::WebSocket::Server — server helper class, your server-side bestie 🫶
• Protocol::WebSocket::Client — client helper class, the client-side icon 💅

🧚 Low-level modules 🧚

• Protocol::WebSocket::Handshake::Server — server handshake parser and constructor.
• Protocol::WebSocket::Handshake::Client — client handshake parser and constructor.
• Protocol::WebSocket::Frame — WebSocket frame parser and constructor.
• Protocol::WebSocket::Request — low level WebSocket request parser and constructor.
• Protocol::WebSocket::Response — low level WebSocket response parser and constructor.
• Protocol::WebSocket::URL — low level WebSocket url parser and constructor.

⭐ EXAMPLES ⭐

For examples on how to use Protocol::WebSocket with various event loops, see the examples/ directory in the distribution 👀✨

🎀 CREDITS 🎀

In order of appearance:

• Paul "LeoNerd" Evans
• Jon Gentle
• Lee Aylward
• Chia-liang Kao
• Atomer Ju
• Chuck Bredestege
• Matthew Lien (BlueT)
• Joao Orui
• Toshio Ito (debug-ito)
• Neil Bowers
• Michal Špaček
• Graham Ollis
• Anton Petrusevich
• Eric Wastl

👑 AUTHOR 👑

Viacheslav Tykhanovskyi, "vti@cpan.org" 💌

💜 COPYRIGHT 💜

Copyright (C) 2010-2018, Viacheslav Tykhanovskyi.

This program is free software, you can redistribute it and/or modify it under the same terms as Perl 5.10 ✨

---

mwah 💋 — this whole vibe is Protoc...bSocket(3pm) from perl v5.42.0, dated 2019-03-13. bye bestie, go build something iconic 🎀💖