d03416e779b8d47ffccdae1ac0740d099cda1890
[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
116
117 =head1 AUTHOR
118
119 Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >>
120
121 =head1 BUGS
122
123 Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through
124 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>.  I will be notified, and then you'll
125 automatically be notified of progress on your bug as I make changes.
126
127
128
129
130 =head1 SUPPORT
131
132 You can find documentation for this module with the perldoc command.
133
134     perldoc Redis
135
136
137 You can also look for information at:
138
139 =over 4
140
141 =item * RT: CPAN's request tracker
142
143 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis>
144
145 =item * AnnoCPAN: Annotated CPAN documentation
146
147 L<http://annocpan.org/dist/Redis>
148
149 =item * CPAN Ratings
150
151 L<http://cpanratings.perl.org/d/Redis>
152
153 =item * Search CPAN
154
155 L<http://search.cpan.org/dist/Redis>
156
157 =back
158
159
160 =head1 ACKNOWLEDGEMENTS
161
162
163 =head1 COPYRIGHT & LICENSE
164
165 Copyright 2009 Dobrica Pavlinusic, all rights reserved.
166
167 This program is free software; you can redistribute it and/or modify it
168 under the same terms as Perl itself.
169
170
171 =cut
172
173 1; # End of Redis