Session(3pm)

NAME

HTML::Embperl::Session - adaptation of Apache::Session to work with
HTML::Embperl

DESCRIPTION

An adaptation of Apache::Session to work with HTML::Embperl

SYNOPSIS

Addtional Attributes for TIE
    lazy
        By Specifing this attribute, you tell Apache::Session to not do any
        access to the object store, until the first read or write access to
        the tied hash. Otherwise the tie function will make sure the hash
        exist or creates a new one.

    create_unknown
        Setting this to one causes Apache::Session to create a new session
        with the given id (or a new id, depending on "recreate_id") when
        the specified session id does not exists. Otherwise it will die.

    recreate_id
        Setting this to one causes Apache::Session to create a new session
        id when the specified session id does not exists.

    object_store
        Specify the class for the object store. (The Apache::Session::
        prefix is optional) Only for Apache::Session 1.00.

    lock_manager
        Specify the class for the lock manager. (The Apache::Session::
        prefix is optional) Only for Apache::Session 1.00.

    Store
        Specify the class for the object store. (The Apache::Session::Store
        prefix is optional) Only for Apache::Session 1.5x.

    Lock
        Specify the class for the lock manager. (The Apache::Session::Lock
        prefix is optional) Only for Apache::Session 1.5x.

    Generate
        Specify the class for the id generator. (The
        Apache::Session::Generate prefix is optional) Only for
        Apache::Session 1.5x.

    Serialize
        Specify the class for the data serializer. (The
        Apache::Session::Serialize prefix is optional) Only for
        Apache::Session 1.5x.

    Example using attrubtes to specfiy store and object classes instead of
    a derived class:

     use HTML::Embperl::Session;

     tie %session, 'HTML::Embperl::Session', undef,
        {
        object_store => 'DBIStore',
        lock_manager => 'SysVSemaphoreLocker',
        DataSource => 'dbi:Oracle:db'
        };

    NOTE: HTML::Embperl::Session will require the nessecary additional perl
    modules for you.

Addtional Methods
    setid
        Set the session id for futher accesses.

    getid
        Get the session id. The difference to using $session{_session_id}
        is, that in lazy mode, getid will not create a new session id, if
        it doesn't exists.

    cleanup
        Writes any pending data, releases all locks and deletes all data
        from memory.

AUTHORS

Gerald Richter <richter@dev.ecos.de> is the current maintainer.

This class was written by Jeffrey Baker (jeffrey@kathyandjeffrey.net)
but it is taken wholesale from a patch that Gerald Richter
(richter@ecos.de) sent me against Apache::Session.
Copyright © 2010-2025 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout