ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/BDB/BDB.pm
(Generate patch)

Comparing BDB/BDB.pm (file contents):
Revision 1.36 by root, Sat May 10 20:23:06 2008 UTC vs.
Revision 1.38 by root, Mon Jul 7 22:11:04 2008 UTC

… …
113BEGIN { 113BEGIN {
114 our $VERSION = '1.5'; 114 our $VERSION = '1.5';
115 115
116 our @BDB_REQ = qw( 116 our @BDB_REQ = qw(
117 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect 117 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect
118 db_env_memp_sync db_env_memp_trickle 118 db_env_memp_sync db_env_memp_trickle db_env_dbrename db_env_dbremove
119 db_open db_close db_compact db_sync db_upgrade 119 db_open db_close db_compact db_sync db_upgrade
120 db_put db_get db_pget db_del db_key_range 120 db_put db_get db_pget db_del db_key_range
121 db_txn_commit db_txn_abort db_txn_finish 121 db_txn_commit db_txn_abort db_txn_finish
122 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del 122 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del
123 db_sequence_open db_sequence_close 123 db_sequence_open db_sequence_close
… …
156settings) are method calls on the relevant objects, so the rule of thumb 156settings) are method calls on the relevant objects, so the rule of thumb
157is: if it's a method, it's not blocking, if it's a function, it takes a 157is: if it's a method, it's not blocking, if it's a function, it takes a
158callback as last argument. 158callback as last argument.
159 159
160In the following, C<$int> signifies an integer return value, 160In the following, C<$int> signifies an integer return value,
161C<octetstring> is a "binary string" (i.e. a perl string with no character 161C<bdb_filename> is a "filename" (octets on unix, madness on windows),
162indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some 162C<U32> is an unsigned 32 bit integer, C<int> is some integer, C<NV> is a
163integer, C<NV> is a floating point value. 163floating point value.
164 164
165The C<SV *> types are generic perl scalars (for input and output of data 165The C<SV *> types are generic perl scalars (for input and output of data
166values), and the C<SV *callback> is the optional callback function to call 166values), and the C<SV *callback> is the optional callback function to call
167when the request is completed. 167when the request is completed.
168 168
… …
176Functions in the BDB namespace, exported by default: 176Functions in the BDB namespace, exported by default:
177 177
178 $env = db_env_create (U32 env_flags = 0) 178 $env = db_env_create (U32 env_flags = 0)
179 flags: RPCCLIENT 179 flags: RPCCLIENT
180 180
181 db_env_open (DB_ENV *env, octetstring db_home, U32 open_flags, int mode, SV *callback = &PL_sv_undef) 181 db_env_open (DB_ENV *env, bdb_filename db_home, U32 open_flags, int mode, SV *callback = &PL_sv_undef)
182 open_flags: INIT_CDB INIT_LOCK INIT_LOG INIT_MPOOL INIT_REP INIT_TXN RECOVER RECOVER_FATAL USE_ENVIRON USE_ENVIRON_ROOT CREATE LOCKDOWN PRIVATE REGISTER SYSTEM_MEM 182 open_flags: INIT_CDB INIT_LOCK INIT_LOG INIT_MPOOL INIT_REP INIT_TXN RECOVER RECOVER_FATAL USE_ENVIRON USE_ENVIRON_ROOT CREATE LOCKDOWN PRIVATE REGISTER SYSTEM_MEM
183 db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = &PL_sv_undef) 183 db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = &PL_sv_undef)
184 db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = &PL_sv_undef) 184 db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = &PL_sv_undef)
185 flags: FORCE 185 flags: FORCE
186 db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = &PL_sv_undef) 186 db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = &PL_sv_undef)
187 atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST 187 atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST
188 db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = &PL_sv_undef) 188 db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = &PL_sv_undef)
189 db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = &PL_sv_undef) 189 db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = &PL_sv_undef)
190 db_env_dbremove (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, U32 flags = 0, SV *callback = &PL_sv_undef)
191 db_env_dbrename (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, bdb_filename newname, U32 flags = 0, SV *callback = &PL_sv_undef)
190 192
191 $db = db_create (DB_ENV *env = 0, U32 flags = 0) 193 $db = db_create (DB_ENV *env = 0, U32 flags = 0)
192 flags: XA_CREATE 194 flags: XA_CREATE
193 195
194 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) 196 db_open (DB *db, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)
195 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE 197 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE
196 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 198 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
197 flags: DB_NOSYNC 199 flags: DB_NOSYNC
198 db_upgrade (DB *db, octetstring file, U32 flags = 0, SV *callback = &PL_sv_undef) 200 db_upgrade (DB *db, bdb_filename file, U32 flags = 0, SV *callback = &PL_sv_undef)
199 db_compact (DB *db, DB_TXN_ornull *txn = 0, SV *start = 0, SV *stop = 0, SV *unused1 = 0, U32 flags = DB_FREE_SPACE, SV *unused2 = 0, SV *callback = &PL_sv_undef) 201 db_compact (DB *db, DB_TXN_ornull *txn = 0, SV *start = 0, SV *stop = 0, SV *unused1 = 0, U32 flags = DB_FREE_SPACE, SV *unused2 = 0, SV *callback = &PL_sv_undef)
200 flags: FREELIST_ONLY FREE_SPACE 202 flags: FREELIST_ONLY FREE_SPACE
201 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 203 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
202 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef) 204 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef)
203 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) 205 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
… …
611 613
612=item BDB::set_sync_prepare $cb 614=item BDB::set_sync_prepare $cb
613 615
614Sets a callback that is called whenever a request is created without an 616Sets a callback that is called whenever a request is created without an
615explicit callback. It has to return two code references. The first is used 617explicit callback. It has to return two code references. The first is used
616as the request callback, and the second is called to wait until the first 618as the request callback (it should save the return status), and the second
619is called to wait until the first callback has been called (it must set
620C<$!> to the return status).
621
622This mechanism can be used to include BDB into other event mechanisms,
623such as L<AnyEvent::BDB> or L<Coro::BDB>.
624
617callback has been called. The default implementation works like this: 625The default implementation works like this:
618 626
619 sub { 627 sub {
620 my $status; 628 my $status;
621 ( 629 (
622 sub { $status = $! }, 630 sub { $status = $! },
623 sub { BDB::poll while !defined $status; $! = $status }, 631 sub { BDB::poll while !defined $status; $! = $status },
624 ) 632 )
625 } 633 }
634
635It simply blocks the process till the request has finished and then sets
636C<$!> to the return value. This means that if you don't use a callback,
637BDB will simply fall back to synchronous operations.
626 638
627=back 639=back
628 640
629=head3 STATISTICAL INFORMATION 641=head3 STATISTICAL INFORMATION
630 642

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines