File 'net/pop3/storage/multi.cls' (part of 'Pool_Net')


Home | Packages | Files | Procedures | Classes | Keywords | External packages


Written by
Andreas Kupries
Description
Storage facility employing other storage systems
Keywords
storage facility

Class 'multiStorage'

Description
Storage system usable by the pop client in pop3Client. Refers to several external storage systems, as configured by the user, via add. Scans through all of them for every incoming mail until a success is reported. The scan process is event controlled, more than one can be in progress.
Superclasses
popClientStorageBase
Options
command
Membervariables
facilities, thread
Methods
Done, Execute, Store, SubDone, add, storeMessage

-command
The command to evaluate after a scan completed. First argument is either 'done' or 'error'. In the latter case the accompanying error message is appended as the 2nd argument.

facilities
A list containing the object handles of all storage system to query during a scan.
thread
State information for every active scan.

Done (command fail msg)

Overides base class functionality to allow the notification of someone outside about the completion of the scan. The standard functionality just notifies the caller.
Argument: commandThe script evaluate. Allowed to be empty, nothing is done in that case. Gets either 'error' or 'done' as first argument. In case of an 'error' msg is given to as well.
Argument: failBoolean value. True signal unsucessful completion of the storing process.
Argument: msg (= {})The error text to add as 2nd argument to command.

Execute (handle)

Invokes the chosen storage facility for the given scan.
Argument: handleInternal handle of this storage transaction. Used to remember the transaction state.

Store (handle)

Stores the message in the given scan state (handle) using the facility next on the list in the same state.
Argument: handleInternal handle of this storage transaction. Used to remember the transaction state.

SubDone (handle state msg)

Callback used by the invoked facility to notify this object about its success (or failure).
Argument: handleInternal handle of this storage transaction. Used to remember the transaction state.
Argument: stateCompletion state of the invoked facility.
Argument: msg (= {})Error message in case of failure.

add (o)

Adds the storage facility o to this object.
Argument: oHandle of the storage object to add. Must be derived from popClientStorageBase.

storeMessage (command message)

Stores the given message, tries all facilities known to the object.
Argument: commandThe script evaluate after completion of the process (use Done to accomplish this). Allowed to be empty, nothing is done in that case. Gets either 'error' or 'done' as first argument.
Argument: messageThe text of the message to store.


Generated by AutoDoc 2.1 at 02/20/1999, invoked by Andreas Kupries