aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ManaTools/Shared/disk_backend/Plugin.pm
blob: e38553a5cd1344f33a9781c7087f92f515809a0c (plain)
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# vim: set et ts=4 sw=4:
package ManaTools::Shared::disk_backend::Plugin;

#============================================================= -*-perl-*-

=head1 NAME

    ManaTools::Shared::disk_backend::Plugin - disks object

=head1 SYNOPSIS

    package ManaTools::Shared::disk_backend::Plugin::Foo;
    use Moose;

    extend 'ManaTools::Shared::disk_backend::Plugin';

    override('load', sub {
        ...
    });

    override('save', sub {
        ...
    });

    override('probe', sub {
        ...
    });

    override('probeio', sub {
        ...
    });

    1;

    package ManaTools::Shared::disk_backend::IO::Bar;
    use Moose;

    extend 'ManaTools::Shared::disk_backend::IO';

    has '+type', default => 'bar';

    ...

    1;

    package ManaTools::Shared::disk_backend::Part::Baz;
    use Moose;

    extend 'ManaTools::Shared::disk_backend::Part';

    has '+type', default => 'baz';
    has '+in_restriction', default => sub { ... };
    has '+out_restriction', default => sub { ... };

    ...

    1;

=head1 DESCRIPTION

    This plugin is a abstract plugin for the backend to manadisk

=head1 SUPPORT

    You can find documentation for this plugin with the perldoc command:

    perldoc ManaTools::Shared::disk_backend::Plugin


=head1 AUTHOR

    Maarten Vanraes <alien@rmail.be>

=head1 COPYRIGHT and LICENSE

Copyright (c) 2015 Maarten Vanraes <alien@rmail.be>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

=head1 METHODS

=cut

use Moose;

## class DATA
has 'dependencies' => (
    is => 'ro',
    init_arg => undef,
    isa => 'ArrayRef[Str]',
    lazy => 1,
    default => sub {
        return [];
    }
);

has 'parent' => (
    is => 'ro',
    isa => 'ManaTools::Shared::disk_backend',
    required => 1
);

#=============================================================

=head2 load

=head3 OUTPUT

    0 if failed, 1 if success

=head3 DESCRIPTION

    this is a default method for loading Part's, the idea is to override it if needed

=cut

#=============================================================
sub load {
    my $self = shift;

    1;
}

#=============================================================

=head2 save

=head3 OUTPUT

    0 if failed, 1 if success

=head3 DESCRIPTION

    this is a default method for saving Part's, the idea is to override it if needed

=cut

#=============================================================
sub save {
    my $self = shift;

    1;
}

#=============================================================

=head2 probe

=head3 OUTPUT

    0 if failed, 1 if success

=head3 DESCRIPTION

    this is a default method for probing IO's and/or Part's, the idea is to override it if needed

=cut

#=============================================================
sub probe {
    my $self = shift;

    1;
}

#=============================================================

=head2 loadio

=head3 OUTPUT

    0 if failed, 1 if success

=head3 DESCRIPTION

    this is a default method for loading a Part from a specific IO, the idea is to override it if needed

=cut

#=============================================================
sub loadio {
    my $self = shift;
    my $io = shift;

    1;
}

#=============================================================

=head2 savepart

=head3 OUTPUT

    0 if failed, 1 if success

=head3 DESCRIPTION

    this is a default method for saving a specific Part, the idea is to override it if needed

=cut

#=============================================================
sub savepart {
    my $self = shift;
    my $part = shift;

    1;
}

#=============================================================

=head2 probeio

=head3 OUTPUT

    0 if failed, 1 if success

=head3 DESCRIPTION

    this is a default method for probing specific a specific IO, the idea is to override it if needed

=cut

#=============================================================
sub probeio {
    my $self = shift;
    my $io = shift;

    1;
}

1;