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 |
tcidbput |
34 |
tcidbout |
35 |
tcidbget |
36 |
); |
37 |
|
38 |
=head1 NAME |
39 |
|
40 |
Search::TokyoDystopia - XS bindings for Tokyo Dystopia |
41 |
|
42 |
=head1 EXPORTS |
43 |
|
44 |
If you don't prevent it, it will export all kind of stuff into your namespace to cut down on typing. |
45 |
|
46 |
=head2 tcidberrmsg |
47 |
|
48 |
my $message = tcidberrmsg( $ecode ); |
49 |
|
50 |
=head2 tcidbnew |
51 |
|
52 |
my $idb = tcidbnew; |
53 |
|
54 |
=head2 tcidbdel |
55 |
|
56 |
tcidbdel( $idb ); |
57 |
|
58 |
=head2 tcidbecode |
59 |
|
60 |
my $ecode = tcidbecode( $idb ); |
61 |
|
62 |
=head2 tcidbtune |
63 |
|
64 |
my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE | IDBTDEFLATE ); |
65 |
|
66 |
=cut |
67 |
|
68 |
use constant { |
69 |
IDBTLARGE => 1 << 0, |
70 |
IDBTDEFLATE => 1 << 1, |
71 |
IDBTTCBS => 1 << 2, |
72 |
}; |
73 |
|
74 |
=head2 tcidbsetcache |
75 |
|
76 |
my $success = tcidbsetcache( $idb, $icsiz, $lcnum ); |
77 |
|
78 |
=head2 tcidbsetfwmmax |
79 |
|
80 |
my $success = tcidbsetfwmmax( $idb, $fwnum ); |
81 |
|
82 |
=head2 tcidbopen |
83 |
|
84 |
my $success = tcidbopen( $idb, 'casket', IDBOWRITER | IDBOCREAT ); |
85 |
|
86 |
=cut |
87 |
|
88 |
use constant { |
89 |
IDBOREADER => 1 << 0, |
90 |
IDBOWRITER => 1 << 1, |
91 |
IDBOCREAT => 1 << 2, |
92 |
IDBOTRUNC => 1 << 3, |
93 |
IDBONOLCK => 1 << 4, |
94 |
IDBOLCKNB => 1 << 5, |
95 |
}; |
96 |
|
97 |
=head2 tcidbclose |
98 |
|
99 |
my $success = tcidbclose( $idb ); |
100 |
|
101 |
=head2 tcidbput |
102 |
|
103 |
my $success = tcidbput( $idb, $id, $text ); |
104 |
|
105 |
=head2 tcidbout |
106 |
|
107 |
my $success = tcidbout( $idb, $id ); |
108 |
|
109 |
=head2 tcidbget |
110 |
|
111 |
my $text = tcidbget( $idb, $id ); |
112 |
|
113 |
=head1 KNOWN BUGS |
114 |
|
115 |
Low-level functions often just die when called on invalid (or deleted) database |
116 |
|
117 |
=cut |
118 |
|
119 |
1; |