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.

idfrom

instead of passing in a session id, you can pass in a string, from which Apache::SessionX generates the id in case it needs one. The main advantage from generating the id by yourself is, that in 'lazy' mode the id is only generated when the session is accessed.

newid

Setting this to one will cause Apache::SessionX to generate a new id every time the session is saved. If you call "getid" or "getids" it will return the new id that will be used to save the data.

config

Use predefiend config from Apache::SessionX::Config, which is defined by Makefile.PL

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 Apache::SessionX
 tie %session, 'Apache::SessionX', undef,
    { 
    object_store => 'DBIStore',
    lock_manager => 'SysVSemaphoreLocker',
    DataSource => 'dbi:Oracle:db' 
    };

NOTE: Apache::SessionX will "require" the nessecary additional perl modules for you.

Addtional Methods¶

setid ($id)

Set the session id for futher accesses.

setidfrom ($string)

Set the string that is passed to the generate function to compute the id.

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.

getids ($init)

return the an array where the first element is the initial id, the second element is the current id and the third element is set to true, when the session data was modified. If the session was deleted, the initial id (first array value) will be set to '!DELETE'.

If the optional parameter $init is set to true, getids will initialize the session (i.e. read from the store) when not already done.

cleanup

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