| 1 | package Net::WebSocket::PMCE; | ||
| 2 | |||
| 3 | =encoding utf-8 | ||
| 4 | |||
| 5 | =head1 NAME | ||
| 6 | |||
| 7 | Net::WebSocket::PMCE - WebSocket per-message compression extensions | ||
| 8 | |||
| 9 | =head1 DESCRIPTION | ||
| 10 | |||
| 11 | This module itself does nothing useful. It exists as a placeholder | ||
| 12 | for documentation on Net::WebSocket’s implementation of PMCEs | ||
| 13 | (per-message compression extensions), as defined in | ||
| 14 | L<RFC 7692|https://tools.ietf.org/html/rfc7692>. | ||
| 15 | |||
| 16 | If you’re looking for an implementation of the C<permessage-deflate> | ||
| 17 | extension, look at L<Net::WebSocket::PMCE::deflate>. Note that | ||
| 18 | C<permessage-deflate> is a specific B<example> of a PMCE; | ||
| 19 | as of this writing it’s also the only | ||
| 20 | one that seems to enjoy widespread use. | ||
| 21 | |||
| 22 | =head1 DESIGN | ||
| 23 | |||
| 24 | PMCEs implement behavior in both the handshake and in the data | ||
| 25 | exchange portion of a WebSocket session. Like Net::WebSocket itself, then, | ||
| 26 | Net::WebSocket::PMCE modules are sensibly divided into modules that handle | ||
| 27 | handshake logic (e.g., L<Net::WebSocket::PMCE::deflate::Server>) and those | ||
| 28 | that handle data (e.g., L<Net::WebSocket::PMCE::deflate::Data::Server>). | ||
| 29 | |||
| 30 | =head1 STATUS | ||
| 31 | |||
| 32 | Net::WebSocket’s PMCE support is in ALPHA status. Changes to the API are | ||
| 33 | not unlikely; be sure to check the changelog before updating, | ||
| 34 | and please report any issues you find. | ||
| 35 | |||
| 36 | =head1 REPOSITORY | ||
| 37 | |||
| 38 | L<https://github.com/FGasper/p5-Net-WebSocket> | ||
| 39 | |||
| 40 | =head1 AUTHOR | ||
| 41 | |||
| 42 | Felipe Gasper (FELIPE) | ||
| 43 | |||
| 44 | =head1 COPYRIGHT | ||
| 45 | |||
| 46 | Copyright 2017 by L<Gasper Software Consulting|http://gaspersoftware.com> | ||
| 47 | |||
| 48 | =head1 LICENSE | ||
| 49 | |||
| 50 | This distribution is released under the same license as Perl. | ||
| 51 | |||
| 52 | =cut | ||
| 53 | |||
| 54 | die 'Don’t use this module.'; | ||
| 55 | |||
| 56 | 1; |