.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TM::Synchronizable 3pm"
.TH TM::Synchronizable 3pm "2019-09-07" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
TM::Synchronizable \- Topic Maps, trait for synchronizable resources
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&   # 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 => \*(Aqfile:/where/ever\*(Aq);
\&   $tm\->sync_in;
\&   # work with the map, etc...
\&   $tm\->sync_out;
.Ve
.SH "DESCRIPTION"
.IX Header "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 \s-1URI.\s0
Consequently, this trait inherits from TM::ResourceAble, although Class::Trait does not do
this for you (sadly).
.PP
The trait provides the methods \f(CW\*(C`sync_in\*(C'\fR and \f(CW\*(C`sync_out\*(C'\fR to implement the synchronization. In this
process it uses the timestamp of the map (\f(CW\*(C`last_mod\*(C'\fR) and that of the resource \f(CW\*(C`mtime\*(C'\fR.
.PP
Unfortunately, the granularity of the two are different (at least on current \s-1UNIX\s0 systems): for the
\&\fIlast modification\fR time values from Time::HiRes is used. \s-1UNIX\s0 resources only use an integer.
.PP
\&\fBNote\fR: This needs a bit of consideration from the user's side.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "Methods"
.IX Subsection "Methods"
.IP "\fBsync_in\fR" 4
.IX Item "sync_in"
\&\fI\f(CI$tm\fI\fR\->sync_in
.Sp
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 (\f(CW\*(C`mtime\*(C'\fR) is more recent
than that of the map (\f(CW\*(C`last_mod\*(C'\fR), then synchronisation from the resource to the in-memory map will
be triggered. For this, a method \f(CW\*(C`source_in\*(C'\fR has to exist for the map object; that will be invoked.
.Sp
[Since \s-1TM 1.53\s0]: Any additional parameters are passed through to the underlying \f(CW\*(C`source_in\*(C'\fR method.
.IP "\fBsync_out\fR" 4
.IX Item "sync_out"
\&\fI\f(CI$tm\fI\fR\->sync_out
.Sp
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 (\f(CW\*(C`last_mod\*(C'\fR) is more recent
than that of the resource (\f(CW\*(C`mtime\*(C'\fR), then a method \f(CW\*(C`source_out\*(C'\fR for the object is triggered.
.Sp
[Since \s-1TM 1.53\s0]: Any additional parameters are passed through to the underlying \f(CW\*(C`source_out\*(C'\fR method.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1TM\s0, TM::ResourceAble
.SH "AUTHOR INFORMATION"
.IX Header "AUTHOR INFORMATION"
Copyright 20(0[6]|10), Robert Barta <drrho@cpan.org>, All rights reserved.
.PP
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