WebSocket/PMCE/deflate/Data/Streamer.pm

filter: Statementstmt 100% 32 / 32 Branchbran 100% 8 / 8 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 8 / 8 Podpod 66.6% 2 / 3 totaltotal 98.0% 50 / 51 CC 5 SCAR 7.7
CC
5
Cov
100%
_create
4.0
new
2.0
BEGIN
1.0
CRAP 2.2
« WebSocket/Constants.pm ↑ Summary WebSocket/Streamer.pm »
1 package Net::WebSocket::PMCE::deflate::Data::Streamer;
2  
3 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 3 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 =encoding utf-8
7  
8 =head1 NAME
9  
10 Net::WebSocket::PMCE::deflate::Data::Streamer
11  
12 =head1 SYNOPSIS
13  
14 my $streamer = $deflate_data->create_streamer( $frame_class );
15  
16 #These frames form a single compressed message in three
17 #fragments whose content is “onetwothree”.
18 my @frames = (
19 $streamer->create_chunk('one'),
20 $streamer->create_chunk('two'),
21 $streamer->create_final('three'),
22 );
23  
24 =head1 DESCRIPTION
25  
26 This class implements fragmentation for the permessage-deflate WebSocket
27 extension. It allows you to send a single message in arbitrarily many
28 parts. The class is not instantiated directly, but instances are returned
29 as the result of L<Net::WebSocket::PMCE::deflate::Data>’s
30 C<create_streamer()> method.
31  
32 Strictly speaking, this is a base class; the C<::Client> and C<::Server>
33 subclasses implement a bit of logic specific to either endpoint type.
34  
35 The C<create_chunk()> and C<create_final()> methods follow the same
36 pattern as L<Net::WebSocket::Streamer>.
37  
38 =cut
39  
40 3 ▶use Module::Runtime ();
Subroutine BEGIN: called CC=1 SCAR=0.0
41  
42 3 ▶use Net::WebSocket::Frame::continuation ();
Subroutine BEGIN: called CC=1 SCAR=0.0
43  
44 =head1 METHODS
45  
46 =cut
47  
48 5 ▶sub new {
Subroutine new: called CC=2 SCAR=6.9
Pod undocumented
49 5 my ($class, $data_obj, $frame_class) = @_;
50  
51 5 ▶ Module::Runtime::require_module($frame_class) if !$frame_class->can('new');
Branch: 1 branch
BranchTrueFalseTotal
unless $frame_class->can("new") 3 2 5
52  
53 5 my $self = {
54 _data_obj => $data_obj,
55 _frame_class => $frame_class,
56 };
57  
58 5 return bless $self, $class;
59 }
60  
61 3 my ($_COMPRESS_FUNC, $_FIN);
62  
63 =head2 I<OBJ>->create_chunk( OCTET_STRING )
64  
65 Compresses OCTET_STRING. The compressor doesn’t necessarily produce output
66 from this, however. If the compressor does produce output, then this
67 method returns a frame object (an instance of either the streamer’s
68 assigned frame class or L<Net::WebSocket::Frame::continuation>); otherwise,
69 undef is returned.
70  
71 =cut
72  
73 58 ▶sub create_chunk {
Subroutine create_chunk: called CC=1 SCAR=0.0
Pod documented
74 58 $_COMPRESS_FUNC = '_compress_non_final_fragment';
75 58 $_FIN = 0;
76  
77 58 goto &_create;
78 }
79  
80 =head2 I<OBJ>->create_final( OCTET_STRING )
81  
82 Compresses OCTET_STRING and flushes the compressor. The output matches
83 that of C<create_chunk()> except that the output is always a frame object.
84 The output of this method will complete the message.
85  
86 =cut
87  
88 5 ▶sub create_final {
Subroutine create_final: called CC=1 SCAR=0.0
Pod documented
89 5 $_COMPRESS_FUNC = $_[0]->{'_data_obj'}{'final_frame_compress_func'};
90 5 $_FIN = 1;
91  
92 5 goto &_create;
93 }
94  
95 63 ▶sub _create {
Subroutine _create: called CC=4 SCAR=13.9
96 63 my ($self) = @_;
97  
98 63 my $data_obj = $self->{'_data_obj'};
99  
100 63 my $payload_sr = \($data_obj->$_COMPRESS_FUNC( $_[1] ));
101  
102 63 ▶ return undef if !length $$payload_sr;
Branch: 1 branch
BranchTrueFalseTotal
unless length $$payload_sr 57 6 63
103  
104 6 ▶ my $class = $self->{'_frames_count'} ? 'Net::WebSocket::Frame::continuation' : $self->{'_frame_class'};
Branch: 1 branch
BranchTrueFalseTotal
$self->{'_frames_count'} ? : 1 5 6
105 6 ▶ my $rsv = $self->{'_frames_count'} ? 0 : $data_obj->INITIAL_FRAME_RSV();
Branch: 1 branch
BranchTrueFalseTotal
$self->{'_frames_count'} ? : 1 5 6
106  
107 6 $self->{'_frames_count'}++;
108  
109 6 return $class->new(
110 payload => $payload_sr,
111 rsv => $rsv,
112 $data_obj->FRAME_MASK_ARGS(),
113 );
114 }
115  
116 3 1;
« WebSocket/Constants.pm ↑ Summary WebSocket/Streamer.pm »