The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

ZZZ / Redis-Parser-XS-0.02 / lib / Redis / Parser / XS.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
—
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

              
package Redis::Parser::XS;
use strict;
use warnings;
no  warnings 'uninitialized';
require Exporter;
our @ISA     = qw(Exporter);
our @EXPORT  = qw(
    parse_redis
);
our $VERSION = '0.02';
require XSLoader;
XSLoader::load('Redis::Parser::XS', $VERSION);
1;
__END__
=head1 NAME
Redis::Parser::XS - unified redis protocol parser
=head1 SYNOPSIS
    use Redis::Parser::XS;
     
    my @output;
     
    my $buf = "+OK" . 
              "\x0d\x0a";
     
    my $len = parse_redis $buf, \@output;
     
    if (!defined $len) {
     
        warn "incorrect protocol message\n";
         
    } elsif ($len == 0) {
     
        warn "not enough data to parse, " . 
             "read some more and try again\n";
         
        if (length ($buf) > 16384) {  # 16k and still incomplete ?
                                      # better to just bail
            ...
        }
    } else { # $len > 0
     
        warn "parsed $len bytes\n";
         
        # got status reply:
        #    @output = ( [ '+', 'OK' ] )
         
        $buf = substr $buf, $len; 
    }
=head1 DESCRIPTION
Easy way to parse unified redis protocol. 
Protocol specification L<http://redis.io/topics/protocol>
=head1 FUNCTIONS
=over 4
=item $len = parse_redis $buf, \@output;
Parses redis protocol messages from C<$buf> and pushes each message
into C<@output>. Returns C<undef> on error or total length of parsed
data. Return value of C<0> returned as a "0 but true" string and
indicates, that there isn't enough data to parse even one message.
Parsed messages added to the C<@output> in the following format:
    @output = (
         
        ['+', 'OK'                 ],  # +OK     CRLF
                                       # 
        ['-', 'ERROR'              ],  # -ERROR  CRLF
                                       #
        [':', '123'                ],  # :123    CRLF
                                       # 
        ['$', 'foo'                ],  # $3      CRLF
                                       # foo     CRLF
                                       #
        ['$', undef                ],  # $-1     CRLF
                                       # 
        ['$', ''                   ],  # $0      CRLF
                                       #         CRLF
                                       #
        ['*', []                   ],  # *0      CRLF
                                       #
        ['*', undef                ],  # *-1     CRLF
                                       #
        ['*', [ 'foo',                 # *2      CRLF 
                ['+', 'OK'],           # $3      CRLF
                 ...         ]         # foo     CRLF
                                       # +OK     CRLF
                                       # ...
                                       #
        ['*', ['foo', undef ]      ],  # *2      CRLF 
                                       # $3      CRLF 
                                       # foo     CRLF 
                                       # $-1     CRLF
    )
=back
=head1 EXPORT
Exports only one function:
    parse_redis
=head1 BENCHMARK
Here is a sample benchmark against L<Protocol::Redis::XS>,
generated by F<eg/bench.pl>:
    Status reply
                              Rate
    Protocol::Redis::XS   281098/s
    Redis::Parser::XS     367589/s
     
    Multibulk reply
                              Rate
    Protocol::Redis::XS   127999/s
    Redis::Parser::XS     270490/s
=head1 SEE ALSO
L<Protocol::Redis::XS>
=head1 AUTHOR
Alexandr Gomoliako <zzz@zzz.org.ua>
=head1 LICENSE
Copyright 2011 Alexandr Gomoliako. All rights reserved.
This module is free software. It may be used, redistributed and/or modified 
under the same terms as Perl itself.
=cut