Migrated setup_fh -> setup and moved lots of POD into the base class
[dbsrgits/DBM-Deep.git] / lib / DBM / Deep / Sector / File / Null.pm
1 package DBM::Deep::Sector::File::Null;
2
3 use 5.006_000;
4
5 use strict;
6 use warnings FATAL => 'all';
7
8 use base qw( DBM::Deep::Sector::File::Data );
9
10 my $STALE_SIZE = 2;
11
12 # Please refer to the pack() documentation for further information
13 my %StP = (
14     1 => 'C', # Unsigned char value (no order needed as it's just one byte)
15     2 => 'n', # Unsigned short in "network" (big-endian) order
16     4 => 'N', # Unsigned long in "network" (big-endian) order
17     8 => 'Q', # Usigned quad (no order specified, presumably machine-dependent)
18 );
19
20 sub type { $_[0]{engine}->SIG_NULL }
21 sub data_length { 0 }
22 sub data { return }
23
24 sub _init {
25     my $self = shift;
26
27     my $engine = $self->engine;
28
29     unless ( $self->offset ) {
30         my $leftover = $self->size - $self->base_size - 1 * $engine->byte_size - 1;
31
32         $self->{offset} = $engine->_request_data_sector( $self->size );
33         $engine->storage->print_at( $self->offset, $self->type ); # Sector type
34         # Skip staleness counter
35         $engine->storage->print_at( $self->offset + $self->base_size,
36             pack( $StP{$engine->byte_size}, 0 ),  # Chain loc
37             pack( $StP{1}, $self->data_length ),  # Data length
38             chr(0) x $leftover,                   # Zero-fill the rest
39         );
40
41         return;
42     }
43 }
44
45 1;
46 __END__