1 |
package Search::TokyoDystopia; |
2 |
|
3 |
use strict; |
4 |
use warnings; |
5 |
|
6 |
require Exporter; |
7 |
require XSLoader; |
8 |
use base qw(Exporter); |
9 |
our $VERSION = '0.00'; |
10 |
our $debug = 0; |
11 |
XSLoader::load('Search::TokyoDystopia', $VERSION); |
12 |
|
13 |
our @EXPORT = qw( |
14 |
tcidberrmsg |
15 |
tcidbnew |
16 |
tcidbdel |
17 |
tcidbnew |
18 |
tcidbecode |
19 |
tcidbtune |
20 |
IDBTLARGE |
21 |
IDBTDEFLATE |
22 |
IDBTTCBS |
23 |
tcidbsetcache |
24 |
tcidbsetfwmmax |
25 |
tcidbopen |
26 |
IDBOREADER |
27 |
IDBOWRITER |
28 |
IDBOCREAT |
29 |
IDBOTRUNC |
30 |
IDBONOLCK |
31 |
IDBOLCKNB |
32 |
tcidbclose |
33 |
); |
34 |
|
35 |
=head1 NAME |
36 |
|
37 |
Search::TokyoDystopia - XS bindings for Tokyo Dystopia |
38 |
|
39 |
=head1 EXPORTS |
40 |
|
41 |
If you don't prevent it, it will export all kind of stuff into your namespace to cut down on typing. |
42 |
|
43 |
=head2 tcidberrmsg |
44 |
|
45 |
my $message = tcidberrmsg( $ecode ); |
46 |
|
47 |
=head2 tcidbnew |
48 |
|
49 |
my $idb = tcidbnew; |
50 |
|
51 |
=head2 tcidbdel |
52 |
|
53 |
tcidbdel( $idb ); |
54 |
|
55 |
=head2 tcidbecode |
56 |
|
57 |
my $ecode = tcidbecode( $idb ); |
58 |
|
59 |
=head2 tcidbtune |
60 |
|
61 |
my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE || IDBTDEFLATE ); |
62 |
|
63 |
=cut |
64 |
|
65 |
use constant { |
66 |
IDBTLARGE => 1 << 0, |
67 |
IDBTDEFLATE => 1 << 1, |
68 |
IDBTTCBS => 1 << 2, |
69 |
}; |
70 |
|
71 |
=head2 tcidbsetcache |
72 |
|
73 |
my $success = tcidbsetcache( $idb, $icsiz, $lcnum ); |
74 |
|
75 |
=head2 tcidbsetfwmmax |
76 |
|
77 |
my $success = tcidbsetfwmmax( $idb, $fwnum ); |
78 |
|
79 |
=head2 tcidbopen |
80 |
|
81 |
my $success = tcidbopen( $idb, 'casket', IDBOWRITER || IDBOCREAT ); |
82 |
|
83 |
=cut |
84 |
|
85 |
use constant { |
86 |
IDBOREADER => 1 << 0, |
87 |
IDBOWRITER => 1 << 1, |
88 |
IDBOCREAT => 1 << 2, |
89 |
IDBOTRUNC => 1 << 3, |
90 |
IDBONOLCK => 1 << 4, |
91 |
IDBOLCKNB => 1 << 5, |
92 |
}; |
93 |
|
94 |
=head2 tcidbclose |
95 |
|
96 |
my $success = tcidbclose( $idb ); |
97 |
|
98 |
=head1 KNOWN BUGS |
99 |
|
100 |
Low-level functions often just die when called on invalid (or deleted) database |
101 |
|
102 |
=cut |
103 |
|
104 |
1; |