The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

DBOOK / Protocol-Redis-XS-0.09 / lib / Protocol / Redis / 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
150
151
152
153
154

              
package Protocol::Redis::XS;
use strict;
use warnings;
use parent "Protocol::Redis";
use XS::Object::Magic;
use XSLoader;
our $VERSION = '0.09';
XSLoader::load "Protocol::Redis::XS", $VERSION;
sub new {
  my($class, %args) = @_;
  my $on_message = delete $args{on_message};
  Carp::croak(qq/Unknown Protocol::Redis API version $args{api}/)
    unless defined $args{api} and $args{api} == 1;
  my $self = bless \%args, $class;
  $self->on_message($on_message) if defined $on_message;
  $self->_create;
  return $self;
}
# See Protocol::Redis for description of the API versioning
sub api {
  my($self) = @_;
  $self->{api};
}
sub on_message {
  my($self, $cb) = @_;
  $self->{_on_message_cb} = $cb;
}
1;
__END__
=head1 NAME
Protocol::Redis::XS - hiredis based parser compatible with Protocol::Redis
=head1 SYNOPSIS
  use Protocol::Redis::XS;
  my $redis = Protocol::Redis::XS->new(api => 1);
  $redis->parse("+OK\r\n");
  my $message = $redis->get_message;
  # create message
  print $redis->encode({type => '*', data => [
    {type => '$', data => 'string'},
    {type => '+', data => 'OK'},
  ]});
=head1 DESCRIPTION
This provides a fast parser for the Redis protocol using the code from
L<hiredis|https://github.com/redis/hiredis> and with API compatibility with
L<Protocol::Redis>.
(If you've found yourself here just looking to use Redis in Perl: This is a low
level parsing module, you probably want to look at the modules mentioned in
L</SEE ALSO> first.)
=head1 METHODS
As per L<Protocol::Redis>, API version 1.
=head2 parse
  $redis->parse("*2\r\n$4ping\r\n\r\n");
Parse a chunk of data (calls L</on_message> callback if defined and a complete
message is received).
=head2 get_message
  while (my $message = $redis->get_message) { ... }
Return a message. This is a potentially nested data structure, for example as
follows:
  {
    type => '*',
    data => [
      {
        type => '$',
        data => 'hello'
      }
    ]
  }
=head2 on_message
  $redis->on_message(sub { my ($redis, $message) = @_; ... });
Set callback for L</parse>.
=head2 encode
  my $string = $redis->encode({type => '*', data => [
    {type => '+', data => 'test'},
    {type => '$', data => 'test'},
  ]});
Encode data into redis message.
=head1 THREADS
This module will work on a threaded perl and will work with threads, however
instances of Protocol::Redis should not be shared between threads.
=head1 SUPPORT
=head2 IRC
L<#redis on irc.perl.org|irc://irc.perl.org/redis>
=head1 DEVELOPMENT
See github: L<https://github.com/dgl/protocol-redis-xs>.
=head1 AUTHOR
David Leadbeater <dgl@dgl.cx>
With thanks to Sergey Zasenko <undef@cpan.org> for the original
L<Protocol::Redis> and defining the API.
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2011 David Leadbeater.
This program is free software; you can redistribute it and/or modify it under
the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=head1 SEE ALSO
L<Redis>, L<Redis::hiredis>, L<Mojo::Redis>, L<AnyEvent::Redis>,
L<Protocol::Redis>.
=cut
# ex:sw=2 et: