- NAME
- SYNOPSIS
- EXPORTS
- DEPENDENCIES
- DESCRIPTION
- PUBLIC INTERFACE

- Add_Handler
- new
- get_path
- get_addr
- get_name
- get_type
- set_data
- get_data
- set_content
- get_content
- set_raw_content
- get_raw_content
- get_stat
- get_mtime
- save
- expire
- refresh
- reload
- is_valid

- PACKAGE INTERNALS

- TIEHASH
- FIRSTKEY
- FETCH
- EXISTS
- STORE
- DELETE
- SCALAR
- __read_from_disk
- __write_to_disk
- __scan

- AUTHORS
- COPYRIGHT

# NAME

Data::Hub::FileSystem::Node -

--title=Data::Hub::FileSystem::Node

# SYNOPSIS

--title=Data::Hub::FileSystem::Node

# EXPORTS

Nothing exported by default

--title=Data::Hub::FileSystem::Node

# DEPENDENCIES

This module requires these other modules and libraries:

        Error::Logical
        Error::Programatic
        Perl::Module
        Fcntl
        Data::Hub::Util
        Data::Hub::Container
        Data::Hub::FileSystem::AccessLog
        Data::OrderedHash
        Tie::Hash

--title=Data::Hub::FileSystem::Node

# DESCRIPTION

--title=Data::Hub::FileSystem::Node

# PUBLIC INTERFACE

## Add_Handler

Add a filesystem node handler

  criteria:

        -type=d         # Directory
        -type=f         # Regular file
        -type=T         # Text file
        -type=B         # Binary file
        -type=!         # Does not exist
        -path=$regex    # Path (with filename) matches $regex
        -crown=$regex   # File's crown matches $regex

## new

Consructor

## get_path

Return the full physical path to this node.

  Base method.

## get_addr

Return the full physical path to this node.

  Base method.

## get_name

Return the file name of this node.

  Base method.

## get_type

Return the Hub type signature for this node

  Base method.

## set_data

Set the data segment of this node

## get_data

Return the data segment of this node

## set_content

Set the content segment of this node

## get_content

Return the content segment of this node

## set_raw_content

Set the literal contents

## get_raw_content

Return the literal contents

## get_stat

Get the stat record for this node

## get_mtime

Modified time of persistent storage

## save

Save changes made to this node

## expire

Detect changes made in persistent storage on next access

## refresh

Detect changes made in persistent storage

## reload

Force this node to reload itself

## is_valid

Are we still a valid handler for this path?

--title=Data::Hub::FileSystem::Node

# PACKAGE INTERNALS

## TIEHASH

See `perltie`

## FIRSTKEY

See `perltie`

  Scan for changes. This allows cached instances to refresh themselves upon member access.

## FETCH

See `perltie`

  Scan for changes.

## EXISTS

See `perltie`

  Scan for changes.

## STORE

See `perltie`

  Scan for changes and update modified time.

## DELETE

See `perltie`

  Scan for changes and update modified time.

## SCALAR

See `perltie`

  Scan for changes and return node contents.

## __read_from_disk

Read instance data from persistent storage

  Base method.

## __write_to_disk

Write instance data to persistent storage

  Abstract base method.

## __scan

Read from disk if necessary

  When `$key` is provided, this resource is then instantiated if necessary. This allows the Data::Hub::FileSystem::Directory manpage to maintain a key/value pair of filename/undef when reading the directory and delay instantiating (and hence recursively reading) the value until it is called upon.

--title=Data::Hub::FileSystem::Node

# AUTHORS

        Ryan Gies <ryangies@cpan.org>

--title=Data::Hub::FileSystem::Node

# COPYRIGHT

        Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
        Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
        Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        * Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.
        * The origin of this software must not be misrepresented; you must not
        claim that you wrote the original software. If you use this software in a
        product, an acknowledgment in the product documentation would be
        appreciated but is not required.
        * Altered source versions must be plainly marked as such, and must not be
        misrepresented as being the original software.
        * The name of the author may not be used to endorse or promote products
        derived from this software without specific prior written permission.

        THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
        WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
        MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
        EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
        EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
        OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
        IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
        OF SUCH DAMAGE.
        To the best of our knowledge, no patented algorithms have been used. However, we
        do not have the resources to carry out a patent search, and therefore cannot
        give any guarantee of the above statement.

--title=Data::Hub::FileSystem::Node