debian man page for text::dhcpleases::object

Text::DHCPLeases::Object(3pm)				User Contributed Perl Documentation			     Text::DHCPLeases::Object(3pm)

NAME
       Text::DHCPLeases::Object - Leases Object Class

SYNOPSIS
       my $obj = Text::DHCPLeases::Object->parse($string);

       or

       my $obj = Text::DHCPLeases::Object->new(%lease_data);

       print $obj->name; print $obj->type; print $obj->binding_state;

DESCRIPTION
       DHCPLeases object class.  Lease objects can be one of the following types:

	   lease
	   host
	   group
	   subgroup
	   failover-state

CLASS METHODS
   new - Constructor
	 Arguments:
	   type 		      one of (lease|host|group|subgroup|failover-state)
	   name 		      identification string (address, host name, group name, etc)
	   ip_address
	   fixed_address
	   starts
	   ends
	   tstp
	   tsfp
	   atsfp
	   cltt
	   next_binding_state
	   binding_state
	   uid
	   client_hostname
	   abandoned		     (flag)
	   deleted		     (flag)
	   dynamic_bootp	     (flag)
	   dynamic		     (flag)
	   option_agent_circuit_id
	   option_agent_remote_id
	   hardware_type
	   mac_address
	   set			     (hash)
	   on			     (hash)
	   bootp		     (flag)
	   reserved		     (flag)
	   my_state
	   my_state_date
	   partner_state
	   partner_state_date
	   mclt
	   dns_rev_name
	   ddns_fwd_name
	   ddns_txt
	 Returns:
	   New Text::DHCPLeases::Object object
	 Examples:

	   my $lease = Text::DHCPLeases::Object->new(type	=> 'lease',
						     ip_address => '192.168.1.10',
						     starts	=> '3 2007/08/15 11:34:58',
						     ends	=> '3 2007/08/15 11:44:58');

   parse - Parse object declaration
       Arguments:
	  Array ref with declaration lines Returns:
	  Hash reference.
	 Examples:

	   my $text = '
       lease 192.168.254.55 {
	 starts 3 2007/08/15 11:34:58;
	 ends 3 2007/08/15 11:44:58;
	 tstp 3 2007/08/15 11:49:58;
	 tsfp 2 2007/08/14 21:24:19;
	 cltt 3 2007/08/15 11:34:58;
	 binding state active;
	 next binding state expired;
	 hardware ethernet 00:11:85:5d:4e:11;
	 uid "010021205]Nh";
	 client-hostname "blah";
       }';

       my $lease_data = Text::DHCPLeases::Lease->parse($text);

INSTANCE METHODS
   print - Print formatted string with lease contents
	 Arguments:
	   None
	 Returns:
	   Formatted String
	 Examples:
	   print $obj->print;

AUTHOR
       Carlos Vicente  <cvicente@cpan.org>

LICENCE AND COPYRIGHT
       Copyright (c) 2007-2010, Carlos Vicente <cvicente@cpan.org>. All rights reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
       THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF
       ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

perl v5.10.0							    2009-08-12					     Text::DHCPLeases::Object(3pm)