Plugins.Session.Arena.Sessions.AnArenaSession Class Reference

An instance of ADataSession customized for use with the various arena engine instances. More...

Inheritance diagram for Plugins.Session.Arena.Sessions.AnArenaSession:

Public Member Functions
def	__init__
	Constructor. More...
def	init
	Initializer.
def	clean
	Delete expired sessions from the data source. More...
def	open
	Start a new session or continue an existing one, if a session ID is specified. More...
def	close
	Close the session.
def	isAnonymous
	Properties -----------------------------------------------------------— Determine whether the session is for an anonymous user or a registered user, based on the "user-name" session variable. More...
def	userName
	Retrieve or set the name of the user, as specified by the session.
def	Mediator
	Retrieve the mediator driving the content provider (and therefore the session)
def	ContentProvider
	Retrieve the content provider.
Public Member Functions inherited from Plugins.Session.DataSessions.ADataSession
def	__init__
	Construct a new session instance that makes use of the specified data source and message log. More...
def	init
	Initializer.
def	__del__
	Destructor.
def	flush
	Flush session information to the data source. More...
def	create
	Create the specified session with the specified length, in seconds. More...
def	load
	Load the session with the specified session ID. More...
def	DataSource
	Retrieve the data source used by the session handler.
def	category
	Retrieve the category in the data source where session data is stored.
Public Member Functions inherited from Plugins.Session.Sessions.ASession
def	__init__
	Construct a new session instance. More...
def	init
	Initializer.
def	flush
	Flush session information to the storage medium. More...
def	close
	Mark the end of the session. More...
def	__del__
	Destructor.
def	create
	Create the specified session with the specified maximum length. More...
def	load
	Load the specified session. More...
def	open
	Open the specified session or, if one is not specified, begin a new session. More...
def	renew
	Renew the session. More...
def	length
	Return the length of the session, in seconds. More...
def	__len__
	Return the length of the session, in seconds. More...
def	Log
	Retrieve a reference to the message log that is being used by the session to log errors and other diagnostic information. More...
def	id
	Retrieve the session ID. More...
def	changed
	Retrieve whether or not session information has changed. More...
def	opened
	Retrieve the time, in seconds since the Unix epoch, at which the session began. More...
def	closed
	Retrieve the time, in seconds since the Unix epoch, at which the session ended. More...
def	expiration
	Retrieve the time, in seconds since the Unix epoch, at which the session will expire. More...
def	expirationTimeStamp
	Return a string representation of the date and time at which the session will expire, formatted using the specified format. More...
def	maxLength
	Retrieve the maximum number of seconds alotted to the session. More...
def	hasExpired
	Determine whether or not the session has expired.
def	Variables
	Retrieve the session variables. More...
def	__getitem__
	Retrieve the specified item from the session keys. More...
def	__setitem__
	Set the specified item in the session keys. More...
def	__delitem__
	Delete the specified item from the session keys. More...
def	__iter__
	Create an iterator for the keys in the session variables. More...
def	iterkeys
	Create an iterator for the keys in the session variables. More...
def	__reversed__
	Create an iterator to iterate backwards over the keys in the session variables. More...
def	iteritems
	Create an iterator for the values in the session variables. More...
def	itervalues
	Create an iterator the keys and values in the session variables. More...
def	__contains__
	Determine whether or not the specified key exists in the session variables. More...
Public Member Functions inherited from Library.Base.Events.ALoggingEventfulObject
def	__init__
	Constructor. More...
def	init
	Initializer.
def	error
	Generate an error event. More...
def	log
	Log the specified item. More...
def	Log
	Retrieve the log used by the class.
Public Member Functions inherited from Library.Base.Events.AnEventfulObject
def	__init__
	Constructor. More...
def	init
	Initializer.
def	__del__
	Destructor.
def	parseParams
	Parse the specified parameters, looking for named events and setting event handlers as appropriate. More...
def	generate
	Generate the named event.
def	update
	Update the events generated by the object.
def	error
	Generate an error event. More...
def	toString
	Construct a string representation of the object. More...
def	on
	Set the handler for the specified event. More...
def	onMultiple
	Set handlers for multiple events. More...
def	handlerFor
	Retrieve the handler for the specified event. More...
def	generates
	Determine whether or not the object generates the named event. More...
def	__getitem__
	Retrieve the value of the named property.
def	__setitem__
	Set the value of the named property.
Public Member Functions inherited from Library.Base.Classwork.AnObject
def	init
	Initialize a new object instance. More...
def	__init__
	Construct and initialize a new instance of AnObject. More...
def	__del__
	Destroy the object instance. More...
def	displayName
	Construct a "pretty" display name for the class instance, based on the name of its class. More...
def	implements
	Determine whether the class instance is related to the specified class. More...
def	toString
	Return a string representation of the class, suitable for output to a console or text-based device. More...
def	__str__
	Return a string representation of the class. More...
def	classname
	Return the name of the class from which the instance was created. More...
def	name
	Return the name of the class. More...
Public Member Functions inherited from Library.String.Utilities.IsPrintable
def	toString
	Return a string representation of the class conveniently. More...
def	__str__
	Return a string representation of the class. More...
def	printTo
	Print a string representation of the class to the specified stream. More...

Detailed Description

An instance of ADataSession customized for use with the various arena engine instances.

Constructor & Destructor Documentation

def Plugins.Session.Arena.Sessions.AnArenaSession.__init__	(		Self,
			params
	)

Constructor.

This routine expects that params will contain the following values:

• ContentProvider – The content provider for which the session is loaded

The following optional items may be included in params:

• Mediator – A reference to the content mediator is overseeing the display of content to the client. If this value is omitted, or if it evaluates to None, the session handler will attempt to retrieve a reference to the mediator from the content provider.

Member Function Documentation

def Plugins.Session.Arena.Sessions.AnArenaSession.clean

(

Self

)

Delete expired sessions from the data source.

def Plugins.Session.Arena.Sessions.AnArenaSession.isAnonymous

(

Self

)

Properties -----------------------------------------------------------— Determine whether the session is for an anonymous user or a registered user, based on the "user-name" session variable.

def Plugins.Session.Arena.Sessions.AnArenaSession.open

(

Self

)

Start a new session or continue an existing one, if a session ID is specified.

---

The documentation for this class was generated from the following file:

• Plugins/Session/Arena/Sessions.py