Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

HEXFUSION / Net-Etcd-0.022 / lib / Net / Etcd / Lease.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
155
156
157
158
159
160
161
162
163
164
165
166

              
use utf8;
package Net::Etcd::Lease;
use strict;
use warnings;
use Moo;
use Types::Standard qw(Str Int Bool HashRef ArrayRef);
use Data::Dumper;
use Carp;
use JSON;
with 'Net::Etcd::Role::Actions';
use namespace::clean;
=head1 NAME
Net::Etcd::Lease
=cut
our $VERSION = '0.022';
=head1 DESCRIPTION
LeaseGrant creates a lease which expires if the server does not receive a keepAlive within
a given time to live period. All keys attached to the lease will be expired and deleted if
the lease expires. Each expired key generates a delete event in the event history.
=head1 ACCESSORS
=head2 endpoint
=cut
has endpoint => (
    is      => 'rwp',
    isa     => Str,
);
=head2 TTL
TTL is the advisory time-to-live in seconds.
=cut
has TTL => (
    is       => 'ro',
    isa      => Str,
);
=head2 ID
ID is the requested ID for the lease. If ID is set to 0, the lessor chooses an ID.
=cut
has ID => (
    is       => 'ro',
    coerce   => sub { return $_[0]; },
);
=head2 keys
keys is true to query all the keys attached to this lease.
=cut
has keys => (
    is       => 'ro',
    isa      => Bool,
    coerce => sub { no strict 'refs'; return $_[0] ? JSON::true : JSON::false }
);
=head1 PUBLIC METHODS
=head2 grant
LeaseGrant creates a lease which expires if the server does not receive a keepAlive within
a given time to live period. All keys attached to the lease will be expired and deleted if
the lease expires. Each expired key generates a delete event in the event history.
    $etcd->lease({ ID => 7587821338341002662,  TTL => 20 })->grant
=cut
sub grant {
    my $self = shift;
    $self->{endpoint} = '/lease/grant';
    confess 'TTL and ID are required for ' . __PACKAGE__ . '->grant'
      unless ($self->{ID} &&  $self->{TTL});
    $self->request;
    return $self;
}
=head2 revoke
LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.
    $etcd->lease({ ID => 7587821338341002662 })->revoke
=cut
sub revoke {
    my $self = shift;
    $self->{endpoint} = '/kv/lease/revoke';
    confess 'ID is required for ' . __PACKAGE__ . '->revoke'
      unless $self->{ID};
    $self->request;
    return $self;
}
=head2 ttl
LeaseTimeToLive retrieves lease information.
    $etcd->lease({ ID => 7587821338341002662, keys => 1 })->ttl
=cut
sub ttl {
    my $self = shift;
    $self->{endpoint} = '/kv/lease/timetolive';
    confess 'ID is required for ' . __PACKAGE__ . '->ttl'
      unless $self->{ID};
    $self->request;
    return $self;
}
=head2 keepalive
LeaseKeepAlive keeps the lease alive by streaming keep alive requests from the client
to the server and streaming keep alive responses from the server to the client."
    $etcd->lease({{ ID => 7587821338341002662 })->keepalive
=cut
sub keepalive {
    my $self = shift;
    $self->{endpoint} = '/lease/keepalive';
    confess 'ID is required for ' . __PACKAGE__ . '->keepalive'
      unless $self->{ID};
    $self->request;
    return $self;
}
=head2 leases
lists all existing leases.
    $etcd->lease()->leases
=cut
sub leases {
    my $self = shift;
    $self->{endpoint} = '/kv/lease/leases';
    $self->{json_args} = '{}';
    $self->request;
    return $self;
}
1;