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

Comparing BDB/BDB.pm (file contents):
Revision 1.21 by root, Fri Dec 7 13:38:52 2007 UTC vs.
Revision 1.37 by root, Mon Jul 7 14:28:53 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.3';	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
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<octetstring> is a "binary string" (i.e. a perl string with no character
149	indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some	162	indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some
…		…
180		193
181	db_open (DB db, DB_TXN_ornull txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)	194	db_open (DB db, DB_TXN_ornull txnid, octetstring file, octetstring 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	195	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)	196	db_close (DB db, U32 flags = 0, SV callback = &PL_sv_undef)
184	flags: DB_NOSYNC	197	flags: DB_NOSYNC
		198	db_upgrade (DB db, octetstring 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)	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)
186	flags: FREELIST_ONLY FREE_SPACE	200	flags: FREELIST_ONLY FREE_SPACE
187	db_sync (DB db, U32 flags = 0, SV callback = &PL_sv_undef)	201	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)	202	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)	203	db_put (DB db, DB_TXN_ornull txn, SV key, SV data, U32 flags = 0, SV *callback = &PL_sv_undef)
…		…
385	DESTROY (DBC_ornull *dbc)	399	DESTROY (DBC_ornull *dbc)
386	CODE:	400	CODE:
387	if (dbc)	401	if (dbc)
388	dbc->c_close (dbc);	402	dbc->c_close (dbc);
389		403
		404	$int = $cursor->set_priority ($priority = PRIORITY_*)
		405
390	=head4 Example:	406	=head4 Example:
391		407
392	my $c = $db->cursor;	408	my $c = $db->cursor;
393		409
394	for (;;) {	410	for (;;) {
…		…
427		443
428	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	444	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
429		445
430	=over 4	446	=over 4
431		447
		448	=item $msg = BDB::strerror [$errno]
		449
		450	Returns the string corresponding to the given errno value. If no argument
		451	is given, use C<$!>.
		452
		453	Note that the BDB module also patches the C<$!> variable directly, so you
		454	should be able to get a bdb error string by simply stringifying C<$!>.
		455
432	=item $fileno = BDB::poll_fileno	456	=item $fileno = BDB::poll_fileno
433		457
434	Return the I<request result pipe file descriptor>. This filehandle must be	458	Return the I<request result pipe file descriptor>. This filehandle must be
435	polled for reading by some mechanism outside this module (e.g. Event or	459	polled for reading by some mechanism outside this module (e.g. Event or
436	select, see below or the SYNOPSIS). If the pipe becomes readable you have	460	select, see below or the SYNOPSIS). If the pipe becomes readable you have
…		…
587		611
588	=item BDB::set_sync_prepare $cb	612	=item BDB::set_sync_prepare $cb
589		613
590	Sets a callback that is called whenever a request is created without an	614	Sets a callback that is called whenever a request is created without an
591	explicit callback. It has to return two code references. The first is used	615	explicit callback. It has to return two code references. The first is used
592	as the request callback, and the second is called to wait until the first	616	as the request callback (it should save the return status), and the second
		617	is called to wait until the first callback has been called (it must set
		618	C<$!> to the return status).
		619
		620	This mechanism can be used to include BDB into other event mechanisms,
		621	such as L<AnyEvent::BDB> or L<Coro::BDB>.
		622
593	callback has been called. The default implementation works like this:	623	The default implementation works like this:
594		624
595	sub {	625	sub {
596	my $status;	626	my $status;
597	(	627	(
598	sub { $status = $! },	628	sub { $status = $! },
599	sub { BDB::poll while !defined $status; $! = $status },	629	sub { BDB::poll while !defined $status; $! = $status },
600	)	630	)
601	}	631	}
		632
		633	It simply blocks the process till the request has finished and then sets
		634	C<$!> to the return value. This means that if you don't use a callback,
		635	BDB will simply fall back to synchronous operations.
602		636
603	=back	637	=back
604		638
605	=head3 STATISTICAL INFORMATION	639	=head3 STATISTICAL INFORMATION
606		640
…		…
663		697
664	In short: the parent will, after a short pause, continue as if fork had	698	In short: the parent will, after a short pause, continue as if fork had
665	not been called, while the child will act as if BDB has not been used	699	not been called, while the child will act as if BDB has not been used
666	yet.	700	yet.
667		701
		702	Win32 note: there is no fork on win32, and perls emulation of it is too
		703	broken to be supported, so do not use BDB in a windows pseudo-fork, better
		704	yet, switch to a more capable platform.
		705
668	=head2 MEMORY USAGE	706	=head2 MEMORY USAGE
669		707
670	Per-request usage:	708	Per-request usage:
671		709
672	Each aio request uses - depending on your architecture - around 100-200	710	Each aio request uses - depending on your architecture - around 100-200
…		…
693	TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,	731	TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,
694	above.	732	above.
695		733
696	=head1 SEE ALSO	734	=head1 SEE ALSO
697		735
698	L<Coro::BDB>, L<IO::AIO>.	736	L<AnyEvent::BDB> (event loop integration), L<Coro::BDB> (more natural
		737	syntax), L<IO::AIO> (nice to have).
699		738
700	=head1 AUTHOR	739	=head1 AUTHOR
701		740
702	Marc Lehmann <schmorp@schmorp.de>	741	Marc Lehmann <schmorp@schmorp.de>
703	http://home.schmorp.de/	742	http://home.schmorp.de/

Diff Legend

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

Comparing BDB/BDB.pm (file contents): Revision 1.21 by root, Fri Dec 7 13:38:52 2007 UTC vs. Revision 1.37 by root, Mon Jul 7 14:28:53 2008 UTC

Diff Legend

Comparing BDB/BDB.pm (file contents):
Revision 1.21 by root, Fri Dec 7 13:38:52 2007 UTC vs.
Revision 1.37 by root, Mon Jul 7 14:28:53 2008 UTC