Perl: updated docs.

This commit is contained in:
tokuhirom 2010-05-03 01:09:21 +09:00
parent 77d48f9cee
commit 77f5cb1f1f
2 changed files with 25 additions and 6 deletions

View File

@ -30,6 +30,20 @@ Data::MessagePack - messagepack
Data::MessagePack is a binary packer for perl.
=head1 METHODS
=over 4
=item my $packed = Data::MessagePack->pack($data);
pack the $data to messagepack format string.
=item my $unpacked = Data::MessagePack->unpack($msgpackstr);
unpack the $msgpackstr to messagepack format string.
=back
=head1 Configuration Variables
=over 4

View File

@ -22,21 +22,26 @@ This is an streaming deserializer for messagepack.
=item my $up = Data::MessagePack::Unpacker->new()
create new stream deserializer
create new instance of stream deserializer.
=item $up->execute()
=item my $ret = $up->execute($data, $offset);
=item $up->execute_limit()
=item my $ret = $up->execute_limit($data, $offset, $limit)
=item $up->is_finished()
$up->execute(substr($data, 0, 3), 0);
$up->execute($data, 3);
$offset is the offset of $data.
=item my $bool = $up->is_finished();
is this deserializer finished?
=item $up->data()
=item my $data = $up->data();
returns deserialized object.
=item $up->reset()
=item $up->reset();
reset the stream deserializer, without memory zone.