home *** CD-ROM | disk | FTP | other *** search
-
- <HTML>
- <HEAD>
- <TITLE>Class::Tom - The Transportable Object Model for Perl</TITLE>
- <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
- <LINK REV="made" HREF="mailto:">
- </HEAD>
-
- <BODY>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Class::Tom - The Transportable Object Model for Perl</P></STRONG>
- </TD></TR>
- </TABLE>
-
- <A NAME="__index__"></A>
- <!-- INDEX BEGIN -->
-
- <UL>
-
- <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
-
- <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
- <LI><A HREF="#description">DESCRIPTION</A></LI>
- <LI><A HREF="#methods">METHODS</A></LI>
- <LI><A HREF="#bugs">BUGS</A></LI>
- <LI><A HREF="#author">AUTHOR</A></LI>
- <LI><A HREF="#see also">SEE ALSO</A></LI>
- </UL>
- <!-- INDEX END -->
-
- <HR>
- <P>
- <H1><A NAME="name">NAME</A></H1>
- <P>Class::Tom - The Transportable Object Model for Perl</P>
- <P>
- <HR>
- <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
- <UL>
- <LI>Linux</LI>
- <LI>Solaris</LI>
- <LI>Windows</LI>
- </UL>
- <HR>
- <H1><A NAME="synopsis">SYNOPSIS</A></H1>
- <P>use Class::Tom qw ( restore );</P>
- <P>my $tom = new Class::Tom;</P>
- <P>$tom->insert(<OBJECT>);</P>
- <P>$tom->insert(<ANONYMOUS SUB>);</P>
- <P>$tom->insert(<PACKAGE NAME>);</P>
- <P>my $flat = $tom->store();</P>
- <P>my $newtom = restore( $flat );</P>
- <P>
- <HR>
- <H1><A NAME="description">DESCRIPTION</A></H1>
- <P><CODE>Class::Tom</CODE> allows you to transport objects from one system to another
- without requiring that the packages the object relies on actually exist on
- the other machine.</P>
- <P>
- <HR>
- <H1><A NAME="methods">METHODS</A></H1>
- <DL>
- <DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
- <DD>
- <A HREF="#item_new"><CODE>new</CODE></A> is the objects constructor. It can optionally take the Encoder
- argument if you've created a new encoding scheme.
- <P></P>
- <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
- <DD>
- The <A HREF="#item_insert"><CODE>insert</CODE></A> method accepts one of three things as an argument, a) an
- CODE reference (such as an anonymous subroutine or a reference to a
- subroutine), b) an Object or c) a string that contains the package name.
- If you insert an Object then <A HREF="#item_insert"><CODE>insert</CODE></A> returns the id of that object in
- the internal object list.
- <P></P>
- <DT><STRONG><A NAME="item_extract">extract</A></STRONG><BR>
- <DD>
- The <A HREF="#item_extract"><CODE>extract</CODE></A> method returns an object that has been <A HREF="#item_insert"><CODE>insert</CODE></A>'ed. The
- argument is the Id of the object you insert.
- <P></P>
- <DT><STRONG><A NAME="item_store">store</A></STRONG><BR>
- <DD>
- The <A HREF="#item_store"><CODE>store</CODE></A> method returns the flattened container ready for shipping.
- <P></P>
- <DT><STRONG><A NAME="item_register">register</A></STRONG><BR>
- <DD>
- The <A HREF="#item_register"><CODE>register</CODE></A> method evals each of the methods stored inside the TOM
- compartment
- <P></P>
- <DT><STRONG><A NAME="item_restore">restore</A></STRONG><BR>
- <DD>
- <A HREF="#item_restore"><CODE>restore</CODE></A> is optionally exported, and is used to turn a flattened TOM
- object into a real perl object.
- <P></P></DL>
- <P>
- <HR>
- <H1><A NAME="bugs">BUGS</A></H1>
- <P>There are probably loads. I've not had time to test this on any machine
- other than my own, so your milage may vary. Remember, this is a beta
- version. 3.02 will be the full bugfixed release.</P>
- <P>
- <HR>
- <H1><A NAME="author">AUTHOR</A></H1>
- <P>James A. Duncan <<A HREF="mailto:j@mesduncan.co.uk">j@mesduncan.co.uk</A>></P>
- <P>
- <HR>
- <H1><A NAME="see also">SEE ALSO</A></H1>
- <P><CODE>perl(1)</CODE></P>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Class::Tom - The Transportable Object Model for Perl</P></STRONG>
- </TD></TR>
- </TABLE>
-
- </BODY>
-
- </HTML>
-