[ViewVC] Diff of: cvs/BDB/BDB.pm

Comparing BDB/BDB.pm (file contents):
Revision 1.19 by root, Wed Dec 5 13:01:46 2007 UTC vs.
Revision 1.38 by root, Mon Jul 7 22:11:04 2008 UTC

…		…
24	db_put $db, undef, "key", "data", 0, sub {	24	db_put $db, undef, "key", "data", 0, sub {
25	db_del $db, undef, "key";	25	db_del $db, undef, "key";
26	};	26	};
27	db_sync $db;	27	db_sync $db;
28		28
29	# automatic result processing with AnyEvent:	29	# when you also use Coro, management is easy:
30	our $FH; open $FH, "<&=" . BDB::poll_fileno;	30	use Coro::BDB;
31	our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb);	31
		32	# automatic event loop intergration with AnyEvent:
		33	use AnyEvent::BDB;
32		34
33	# automatic result processing with EV:	35	# automatic result processing with EV:
34	my $WATCHER = EV::io BDB::poll_fileno, EV::READ, \&BDB::poll_cb;	36	my $WATCHER = EV::io BDB::poll_fileno, EV::READ, \&BDB::poll_cb;
35		37
36	# with Glib:	38	# with Glib:
…		…
107	use strict 'vars';	109	use strict 'vars';
108		110
109	use base 'Exporter';	111	use base 'Exporter';
110		112
111	BEGIN {	113	BEGIN {
112	our $VERSION = '1.2';	114	our $VERSION = '1.5';
113		115
114	our @BDB_REQ = qw(	116	our @BDB_REQ = qw(
115	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
116	db_env_memp_sync db_env_memp_trickle	118	db_env_memp_sync db_env_memp_trickle db_env_dbrename db_env_dbremove
117	db_open db_close db_compact db_sync db_put db_get db_pget db_del db_key_range	119	db_open db_close db_compact db_sync db_upgrade
		120	db_put db_get db_pget db_del db_key_range
118	db_txn_commit db_txn_abort db_txn_finish	121	db_txn_commit db_txn_abort db_txn_finish
119	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
120	db_sequence_open db_sequence_close	123	db_sequence_open db_sequence_close
121	db_sequence_get db_sequence_remove	124	db_sequence_get db_sequence_remove
122	);	125	);
…		…
130		133
131	require XSLoader;	134	require XSLoader;
132	XSLoader::load ("BDB", $VERSION);	135	XSLoader::load ("BDB", $VERSION);
133	}	136	}
134		137
		138	=head2 WIN32 FILENAMES/DATABASE NAME MESS
		139
		140	Perl on Win32 supports only ASCII filenames (the reason is that it abuses
		141	an internal flag to store wether a filename is Unicode or ANSI, but that
		142	flag is used for somethign else in the perl core, so there is no way to
		143	detect wether a filename is ANSI or Unicode-encoded). The BDB module
		144	tries to work around this issue by assuming that the filename is an ANSI
		145	filename and BDB was built for unicode support.
		146
135	=head2 BERKELEYDB FUNCTIONS	147	=head2 BERKELEYDB FUNCTIONS
136		148
137	All of these are functions. The create functions simply return a new	149	All of these are functions. The create functions simply return a new
138	object and never block. All the remaining functions all take an optional	150	object and never block. All the remaining functions take an optional
139	callback as last argument. If it is missing, then the fucntion will be	151	callback as last argument. If it is missing, then the function will be
140	executed synchronously.	152	executed synchronously. In both cases, C<$!> will reflect the return value
		153	of the function.
141		154
142	BDB functions that cannot block (mostly functions that manipulate	155	BDB functions that cannot block (mostly functions that manipulate
143	settings) are method calls on the relevant objects, so the rule of thumb	156	settings) are method calls on the relevant objects, so the rule of thumb
144	is: if its a method, its not blocking, if its a function, it takes a	157	is: if it's a method, it's not blocking, if it's a function, it takes a
145	callback as last argument.	158	callback as last argument.
146		159
147	In the following, C<$int> signifies an integer return value,	160	In the following, C<$int> signifies an integer return value,
148	C<octetstring> is a "binary string" (i.e. a perl string with no character	161	C<bdb_filename> is a "filename" (octets on unix, madness on windows),
149	indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some	162	C<U32> is an unsigned 32 bit integer, C<int> is some integer, C<NV> is a
150	integer, C<NV> is a floating point value.	163	floating point value.
151		164
152	The C<SV *> types are generic perl scalars (for input and output of data	165	The C<SV *> types are generic perl scalars (for input and output of data
153	values), and the C<SV *callback> is the optional callback function to call	166	values), and the C<SV *callback> is the optional callback function to call
154	when the request is completed.	167	when the request is completed.
155		168
…		…
163	Functions in the BDB namespace, exported by default:	176	Functions in the BDB namespace, exported by default:
164		177
165	$env = db_env_create (U32 env_flags = 0)	178	$env = db_env_create (U32 env_flags = 0)
166	flags: RPCCLIENT	179	flags: RPCCLIENT
167		180
168	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)
169	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
170	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)
171	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)
172	flags: FORCE	185	flags: FORCE
173	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)
174	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
175	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)
176	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)
177		192
178	$db = db_create (DB_ENV *env = 0, U32 flags = 0)	193	$db = db_create (DB_ENV *env = 0, U32 flags = 0)
179	flags: XA_CREATE	194	flags: XA_CREATE
180		195
181	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)
182	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
183	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)
184	flags: DB_NOSYNC	199	flags: DB_NOSYNC
		200	db_upgrade (DB db, bdb_filename file, U32 flags = 0, SV callback = &PL_sv_undef)
185	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)
186	flags: FREELIST_ONLY FREE_SPACE	202	flags: FREELIST_ONLY FREE_SPACE
187	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)
188	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)
189	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)
…		…
277	$int = $env->set_lk_max_lockers (U32 max)	293	$int = $env->set_lk_max_lockers (U32 max)
278	$int = $env->set_lk_max_locks (U32 max)	294	$int = $env->set_lk_max_locks (U32 max)
279	$int = $env->set_lk_max_objects (U32 max)	295	$int = $env->set_lk_max_objects (U32 max)
280	$int = $env->set_lg_bsize (U32 max)	296	$int = $env->set_lg_bsize (U32 max)
281	$int = $env->set_lg_max (U32 max)	297	$int = $env->set_lg_max (U32 max)
		298	$int = $env->mutex_set_increment (U32 increment)
		299	$int = $env->mutex_set_tas_spins (U32 tas_spins)
		300	$int = $env->mutex_set_max (U32 max)
		301	$int = $env->mutex_set_align (U32 align)
282		302
283	$txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0)	303	$txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0)
284	flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC	304	flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC
285		305
286	=head4 Example:	306	=head4 Example:
…		…
381	DESTROY (DBC_ornull *dbc)	401	DESTROY (DBC_ornull *dbc)
382	CODE:	402	CODE:
383	if (dbc)	403	if (dbc)
384	dbc->c_close (dbc);	404	dbc->c_close (dbc);
385		405
		406	$int = $cursor->set_priority ($priority = PRIORITY_*)
		407
386	=head4 Example:	408	=head4 Example:
387		409
388	my $c = $db->cursor;	410	my $c = $db->cursor;
389		411
390	for (;;) {	412	for (;;) {
…		…
423		445
424	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	446	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
425		447
426	=over 4	448	=over 4
427		449
		450	=item $msg = BDB::strerror [$errno]
		451
		452	Returns the string corresponding to the given errno value. If no argument
		453	is given, use C<$!>.
		454
		455	Note that the BDB module also patches the C<$!> variable directly, so you
		456	should be able to get a bdb error string by simply stringifying C<$!>.
		457
428	=item $fileno = BDB::poll_fileno	458	=item $fileno = BDB::poll_fileno
429		459
430	Return the I<request result pipe file descriptor>. This filehandle must be	460	Return the I<request result pipe file descriptor>. This filehandle must be
431	polled for reading by some mechanism outside this module (e.g. Event or	461	polled for reading by some mechanism outside this module (e.g. Event or
432	select, see below or the SYNOPSIS). If the pipe becomes readable you have	462	select, see below or the SYNOPSIS). If the pipe becomes readable you have
…		…
583		613
584	=item BDB::set_sync_prepare $cb	614	=item BDB::set_sync_prepare $cb
585		615
586	Sets a callback that is called whenever a request is created without an	616	Sets a callback that is called whenever a request is created without an
587	explicit callback. It has to return two code references. The first is used	617	explicit callback. It has to return two code references. The first is used
588	as the request callback, and the second is called to wait until the first	618	as the request callback (it should save the return status), and the second
		619	is called to wait until the first callback has been called (it must set
		620	C<$!> to the return status).
		621
		622	This mechanism can be used to include BDB into other event mechanisms,
		623	such as L<AnyEvent::BDB> or L<Coro::BDB>.
		624
589	callback has been called. The default implementation works like this:	625	The default implementation works like this:
590		626
591	sub {	627	sub {
592	my $status;	628	my $status;
593	(	629	(
594	sub { $status = $! },	630	sub { $status = $! },
595	sub { BDB::poll while !defined $status; $! = $status },	631	sub { BDB::poll while !defined $status; $! = $status },
596	)	632	)
597	}	633	}
		634
		635	It simply blocks the process till the request has finished and then sets
		636	C<$!> to the return value. This means that if you don't use a callback,
		637	BDB will simply fall back to synchronous operations.
598		638
599	=back	639	=back
600		640
601	=head3 STATISTICAL INFORMATION	641	=head3 STATISTICAL INFORMATION
602		642
…		…
659		699
660	In short: the parent will, after a short pause, continue as if fork had	700	In short: the parent will, after a short pause, continue as if fork had
661	not been called, while the child will act as if BDB has not been used	701	not been called, while the child will act as if BDB has not been used
662	yet.	702	yet.
663		703
		704	Win32 note: there is no fork on win32, and perls emulation of it is too
		705	broken to be supported, so do not use BDB in a windows pseudo-fork, better
		706	yet, switch to a more capable platform.
		707
664	=head2 MEMORY USAGE	708	=head2 MEMORY USAGE
665		709
666	Per-request usage:	710	Per-request usage:
667		711
668	Each aio request uses - depending on your architecture - around 100-200	712	Each aio request uses - depending on your architecture - around 100-200
…		…
689	TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,	733	TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,
690	above.	734	above.
691		735
692	=head1 SEE ALSO	736	=head1 SEE ALSO
693		737
694	L<Coro::BDB>, L<IO::AIO>.	738	L<AnyEvent::BDB> (event loop integration), L<Coro::BDB> (more natural
		739	syntax), L<IO::AIO> (nice to have).
695		740
696	=head1 AUTHOR	741	=head1 AUTHOR
697		742
698	Marc Lehmann <schmorp@schmorp.de>	743	Marc Lehmann <schmorp@schmorp.de>
699	http://home.schmorp.de/	744	http://home.schmorp.de/

Diff Legend

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

Comparing BDB/BDB.pm (file contents): Revision 1.19 by root, Wed Dec 5 13:01:46 2007 UTC vs. Revision 1.38 by root, Mon Jul 7 22:11:04 2008 UTC

Diff Legend

Comparing BDB/BDB.pm (file contents):
Revision 1.19 by root, Wed Dec 5 13:01:46 2007 UTC vs.
Revision 1.38 by root, Mon Jul 7 22:11:04 2008 UTC