NAME

Protocol::WebSocket - 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

Client/server WebSocket message and frame parser/constructor. This module does not provide a WebSocket server or client, but is made for using in http servers or clients to provide WebSocket support.

Protocol::WebSocket supports the following WebSocket protocol versions:

    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. The WebSocket version is detected automatically on the server side. On the client side you have set a "version" attribute to an appropriate value.

Protocol::WebSocket itself does not contain any code and cannot be used directly. Instead the following modules should be used: