ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/CBOR-XS/doc/perl-object.pod
Revision: 1.1
Committed: Tue Nov 26 09:43:39 2013 UTC (10 years, 7 months ago) by root
Branch: MAIN
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 =head1 REGISTRATION INFORMATION
2    
3     Tag <unassigned>
4     Data Item array [classname, constructargs...]
5     Semantics Serialised Perl object with classname and constructor arguments
6     Reference http://cbor.schmorp.de/perl-object
7     Contact Marc A. Lehmann <cbor@schmorp.de>
8    
9     =head1 DESCRIPTION
10    
11     The perl-object tag in CBOR can be used to serialise Perl 5 objects into
12     CBOR.
13    
14     The tagged value must be a CBOR array with at least one element. The first
15     element specifies a classname to use in Perl (it can, but does not need
16     to be a string).
17    
18     The encoder and decoder should serialise/deserialise the object using the
19     Types::Serialiser object serialisation protocol. For this, the object's
20     class must have FREEZE and THAW methods that are called like this:
21    
22     @constructargs = $object->FREEZE ("CBOR");
23     $object = $class->THAW ("CBOR", @constructargs);
24    
25     If the class or method is currently not available, the decoder may try to
26     load a Perl module of the same name and retry the method call.
27    
28     =head1 EXAMPLES
29    
30     Example of a hypothetical My::DateTime representation using a unix
31     timestamp:
32    
33     tag(["My::DateTime", 12345678])
34    
35     Example of the corresponding FREEZE method:
36    
37     sub My::DateTime::FREEZE {
38     my ($self, $model) = @_;
39    
40     $self->as_seconds
41     }
42    
43     Example of the corresponding THAW method:
44    
45     sub My::DateTime::THAW {
46     my ($class, $model, $seconds) = @_;
47    
48     $class->new_from_seconds ($seconds)
49     }
50