c5597df58503e333250181c7ee968bfdbc72cb9d
[perl-Redis.git] / lib / Redis.pm
1 package Redis;
2
3 use warnings;
4 use strict;
5
6 use IO::Socket::INET;
7 use Data::Dump qw/dump/;
8 use Carp qw/confess/;
9
10 =head1 NAME
11
12 Redis - The great new Redis!
13
14 =cut
15
16 our $VERSION = '0.01';
17
18
19 =head1 SYNOPSIS
20
21 Pure perl bindings for L<http://code.google.com/p/redis/>
22
23     use Redis;
24
25     my $r = Redis->new();
26
27
28
29
30 =head1 FUNCTIONS
31
32 =head2 new
33
34 =cut
35
36 our $sock;
37 my $server = '127.0.0.1:6379';
38
39 sub new {
40         my $class = shift;
41         my $self = {};
42         bless($self, $class);
43
44         warn "# opening socket to $server";
45
46         $sock ||= IO::Socket::INET->new(
47                 PeerAddr => $server,
48                 Proto => 'tcp',
49         ) || die $!;
50
51         $self;
52 }
53
54 =head1 Connection Handling
55
56 =head2 quit
57
58   $r->quit;
59
60 =cut
61
62 sub quit {
63         my $self = shift;
64
65         close( $sock ) || warn $!;
66 }
67
68 =head2 ping
69
70   $r->ping || die "no server?";
71
72 =cut
73
74 sub ping {
75         print $sock "PING\r\n";
76         my $pong = <$sock>;
77         die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n";
78 }
79
80 =head1 Commands operating on string values
81
82 =head2 set
83
84   $r->set( foo => 'bar', $new );
85
86 =cut
87
88 sub set {
89         my ( $self, $k, $v, $new ) = @_;
90         print $sock ( $new ? "SETNX" : "SET" ) . " $k " . length($v) . "\r\n$v\r\n";
91         my $ok = <$sock>;
92         confess dump($ok) unless $ok eq "+OK\r\n";
93 }
94
95 =head2 get
96
97   my $value = $r->get( 'foo' );
98
99 =cut
100
101 sub get {
102         my ( $self, $k ) = @_;
103         print $sock "GET $k\r\n";
104         my $len = <$sock>;
105 #       warn "# len: ",dump($len);
106         return undef if $len eq "nil\r\n";
107         my $v;
108         read($sock, $v, $len) || die $!;
109 #       warn "# v: ",dump($v);
110         my $crlf;
111         read($sock, $crlf, 2); # skip cr/lf
112         return $v;
113 }
114
115 =head2 incr
116
117   $r->incr('counter');
118   $r->incr('tripplets', 3);
119
120 =cut
121
122 sub sock_result {
123         my $result = <$sock>;
124         warn "# result: ",dump( $result );
125         $result =~ s{\r\n$}{} || warn "can't find cr/lf";
126         return $result;
127 }
128         
129
130 sub incr {
131         my ( $self, $key, $value ) = @_;
132         if ( defined $value ) {
133                 print $sock "INCRBY $key $value\r\n";
134         } else {
135                 print $sock "INCR $key\r\n";
136         }
137         sock_result();
138 }
139
140 =head2 decr
141
142   $r->decr('counter');
143   $r->decr('tripplets', 3);
144
145 =cut
146
147 sub decr {
148         my ( $self, $key, $value ) = @_;
149         if ( defined $value ) {
150                 print $sock "DECRBY $key $value\r\n";
151         } else {
152                 print $sock "DECR $key\r\n";
153         }
154         sock_result();
155 }
156
157 =head2 exists
158
159   $r->exists( 'key' ) && print "got key!";
160
161 =cut
162
163 sub exists {
164         my ( $self, $key ) = @_;
165         print $sock "EXISTS $key\r\n";
166         sock_result();
167 }
168
169 =head2 del
170
171   $r->del( 'key' ) || warn "key doesn't exist";
172
173 =cut
174
175 sub del {
176         my ( $self, $key ) = @_;
177         print $sock "DEL $key\r\n";
178         sock_result();
179 }
180
181 =head1 AUTHOR
182
183 Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >>
184
185 =head1 BUGS
186
187 Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through
188 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>.  I will be notified, and then you'll
189 automatically be notified of progress on your bug as I make changes.
190
191
192
193
194 =head1 SUPPORT
195
196 You can find documentation for this module with the perldoc command.
197
198     perldoc Redis
199
200
201 You can also look for information at:
202
203 =over 4
204
205 =item * RT: CPAN's request tracker
206
207 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis>
208
209 =item * AnnoCPAN: Annotated CPAN documentation
210
211 L<http://annocpan.org/dist/Redis>
212
213 =item * CPAN Ratings
214
215 L<http://cpanratings.perl.org/d/Redis>
216
217 =item * Search CPAN
218
219 L<http://search.cpan.org/dist/Redis>
220
221 =back
222
223
224 =head1 ACKNOWLEDGEMENTS
225
226
227 =head1 COPYRIGHT & LICENSE
228
229 Copyright 2009 Dobrica Pavlinusic, all rights reserved.
230
231 This program is free software; you can redistribute it and/or modify it
232 under the same terms as Perl itself.
233
234
235 =cut
236
237 1; # End of Redis