tm::resourceable::memcached(3pm) [debian man page]

TM::ResourceAble::MemCached(3pm)			User Contributed Perl Documentation			  TM::ResourceAble::MemCached(3pm)

NAME

       TM::ResourceAble::MemCached - Topic Maps, Memcached server backend

SYNOPSIS

	   use TM::ResourceAble::MemCached;
	   use Fcntl;
	   # create/reset new map
	   my $tm = new TM::ResourceAble::MemCached (
		       baseuri => 'http://whereever/',
		       servers => [ localhost:11211 ],
		       mode    => O_TRUNC | O_CREAT,
		    );

	   # use TM interface

	   # open existing map
	   my $tm = new TM::ResourceAble::MemCached (
			baseuri => 'http://whereever/',
			servers => [ localhost:11211 ],
		    );

DESCRIPTION

       This package implements TM using a memcached server farm as backend. You should be able (without much testing, mind you, so it is
       EXPERIMENTAL) to perform all operations according to the TM interface.

       NOTE: The implementation is using the TIE technique (perltie via Tie::StdHash), so maybe there are problems lurking.

       Of course, a set of memcacheds can store any number of maps. To keep them separate, the baseuri is used, so make sure every map gets its
       own baseuri.

INTERFACE

   Constructor
       The constructor expects a hash with the following keys:

       servers (default: none)
	   The value must be a reference to an array of strings, each of the form host:port. If there is no such list, then the constructor will
	   fail.

       mode (default: O_CREAT)
	   The value must be a value from Fcntl to control

	   o   whether the map should be created ("O_CREAT") when it does not exist, and/or

	   o   whether the map should be cleared ("O_TRUNC") when it existed before.

       All other options are passed to the constructor chain of traits (TM::ResourceAble) and superclasses (TM).

SEE ALSO

       TM, TM::ResourceAble

AUTHOR INFORMATION

       Copyright 2010, Robert Barta <drrho@cpan.org>, All rights reserved.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
       http://www.perl.com/perl/misc/Artistic.html

perl v5.10.1							    2010-08-04					  TM::ResourceAble::MemCached(3pm)

TM::Synchronizable(3pm) 				User Contributed Perl Documentation				   TM::Synchronizable(3pm)

NAME

       TM::Synchronizable - Topic Maps, trait for synchronizable resources

SYNOPSIS

	  # you write an input/output driver
	  # see for example TM::Synchronizable::MLDBM
	  package My::WhatEver;

	    # provides source_in and/or source_out methods
	    sub source_in  { .... }

	    sub source_out { .... }

	    1;

	  # you construct your map class
	  package MySyncableMap;

	    use TM;
	    use base qw(TM);
	    use Class::Trait qw(TM::ResourceAble TM::Synchronizable My::WhatEver);

	    1;

	  # you then use that
	  my $tm = MySyncableMap (url => 'file:/where/ever');
	  $tm->sync_in;
	  # work with the map, etc...
	  $tm->sync_out;

DESCRIPTION

       This trait implements the abstract synchronization between in-memory topic maps and the resources which are attached to them, i.e. files,
       web pages, etc. whatever can be addressed via a URI.  Consequently, this trait inherits from TM::ResourceAble, although Class::Trait does
       not do this for you (sadly).

       The trait provides the methods "sync_in" and "sync_out" to implement the synchronization. In this process it uses the timestamp of the map
       ("last_mod") and that of the resource "mtime".

       Unfortunately, the granularity of the two are different (at least on current UNIX systems): for the last modification time values from
       Time::HiRes is used. UNIX resources only use an integer.

       Note: This needs a bit of consideration from the user's side.

INTERFACE

   Methods
       sync_in
	   $tm->sync_in

	   This method provides only the main logic, whether a synchronisation from the resource into the in-memory map should occur. If the last
	   modification date of the resource ("mtime") is more recent than that of the map ("last_mod"), then synchronisation from the resource to
	   the in-memory map will be triggered. For this, a method "source_in" has to exist for the map object; that will be invoked.

	   [Since TM 1.53]: Any additional parameters are passed through to the underlying "source_in" method.

       sync_out
	   $tm->sync_out

	   This method provides the logic, whether synchronisation from the in-memory map towards the attached resource should occur or not. If
	   the last modification date of the map ("last_mod") is more recent than that of the resource ("mtime"), then a method "source_out" for
	   the object is triggered.

	   [Since TM 1.53]: Any additional parameters are passed through to the underlying "source_out" method.

SEE ALSO

       TM, TM::ResourceAble

AUTHOR INFORMATION

       Copyright 20(0[6]|10), Robert Barta <drrho@cpan.org>, All rights reserved.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
       http://www.perl.com/perl/misc/Artistic.html

perl v5.10.1							    2012-06-05						   TM::Synchronizable(3pm)