diff options
Diffstat (limited to 'lib/Config/HAProxy/Node/Root.pm')
-rw-r--r-- | lib/Config/HAProxy/Node/Root.pm | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/lib/Config/HAProxy/Node/Root.pm b/lib/Config/HAProxy/Node/Root.pm index 656bb9f..ca6e575 100644 --- a/lib/Config/HAProxy/Node/Root.pm +++ b/lib/Config/HAProxy/Node/Root.pm @@ -6,2 +6,15 @@ use Carp; +=head1 NAME + +Config::HAProxy::Node::Root - root node of HAProxy configuration parse tree + +=head1 DESCRIPTION + +Objects of this class represent the topmost node in HAProxy configuration tree. +Each parse tree contains exactly one object of this class. This node can be +reached from every node in the tree by following its B<parent> attribute +and is returned by the B<tree> method of B<Config::HAProxy> class. + +=cut + sub new { @@ -13,2 +26,17 @@ sub new { +=head1 METHODS + +=head2 is_root + +Always true. + +=head2 is_dirty + + $bool = $node->is_dirty; + +Returns true if the tree is C<dirty>, i.e. it was modified since it has been +created from the disk configuration file. + +=cut + sub is_dirty { @@ -18,2 +46,10 @@ sub is_dirty { +=head2 mark_dirty + + $node->mark_dirty; + +Sets the C<dirty> attribute. + +=cut + sub mark_dirty { @@ -23,2 +59,10 @@ sub mark_dirty { +=head2 clear_dirty + + $node->clear_dirty; + +Clears the C<dirty> attribute. + +=cut + sub clear_dirty { @@ -28,2 +72,8 @@ sub clear_dirty { +=head1 SEE ALSO + +B<Config::HAProxy::Node>. + +=cut + 1; |