/[Search-TokyoDystopia]/lib/Search/TokyoDystopia.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /lib/Search/TokyoDystopia.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 10 - (show annotations)
Sun Aug 17 23:53:11 2008 UTC (11 years ago) by dpavlin
File size: 1679 byte(s)
- rename function back to original names to prevent another mapping
- export buch of stuff back to caller without asking
- document all functions with snippet from test
- define constants
- added tcidbopen (which doesn't seem to work yet)
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 );
33
34 =head1 NAME
35
36 Search::TokyoDystopia - XS bindings for Tokyo Dystopia
37
38 =head1 EXPORTS
39
40 If you don't prevent it, it will export all kind of stuff into your namespace to cut down on typing.
41
42 =head2 tcidberrmsg
43
44 my $message = Search::TokyoDystopia::tcidberrmsg( $ecode );
45
46 =head2 tcidbnew
47
48 my $idb = Search::TokyoDystopia::tcidbnew;
49
50 =head2 tcidbdel
51
52 Search::TokyoDystopia::tcidbdel( $idb );
53
54 =head2 tcidbecode
55
56 my $ecode = Search::TokyoDystopia::tcidbecode( $idb );
57
58 =head2 tcidbtune
59
60 my $success = Search::TokyoDystopia::tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE || IDBTDEFLATE );
61
62 =cut
63
64 use constant {
65 IDBTLARGE => 1 << 0,
66 IDBTDEFLATE => 1 << 1,
67 IDBTTCBS => 1 << 2,
68 };
69
70 =head2 tcidbsetcache
71
72 my $success = Search::TokyoDystopia::tcidbsetcache( $idb, $icsiz, $lcnum );
73
74 =head2 tcidbsetfwmmax
75
76 my $success = Search::TokyoDystopia::tcidbsetfwmmax( $idb, $fwnum );
77
78 =head2 tcidbopen
79
80 Search::TokyoDystopia::tcidbopen( $idb, 'casket', IDBOTRUNC ), 1, 'tcidbopen' );
81
82 =cut
83
84 use constant {
85 IDBOREADER => 1 << 0,
86 IDBOWRITER => 1 << 1,
87 IDBOCREAT => 1 << 2,
88 IDBOTRUNC => 1 << 3,
89 IDBONOLCK => 1 << 4,
90 IDBOLCKNB => 1 << 5,
91 };
92
93 =head1 KNOWN BUGS
94
95 Low-level functions often just die when called on invalid (or deleted) database
96
97 =cut
98
99 1;

  ViewVC Help
Powered by ViewVC 1.1.26