List::Filter::Storage::MEM - filter storage in memory


List-Filter documentation  | view source Contained in the List-Filter distribution.

Index


NAME

Top

List::Filter::Storage::MEM - filter storage in memory

SYNOPSIS

Top

   use List::Filter::Storage::MEM;
   my $ffpsm = List::Filter::Storage::MEM->new();

   # This is a plugin, not intended for direct use.
   # See: List:Filter:Storage

DESCRIPTION

Top

List::Filter::Storage::MEM, is a Plug-in to use for "storing" List::Filter filters in memory, so that they can be recalled using the List::Filter::Storage interface that scans through multiple storage locations.

The filter_data structure may be passed in as the "connect_to" parameter, or one will be created internally if one has not been passed in. This may be added to with the "save" method. The entire structure can be extracted with the "filter_data" accessor, or (more typically) filter's may be looked up by name, using the "lookup" method.

METHODS

initialization code

new

Instantiates a new List::Filter::Profile object.

Takes an optional hashref as an argument, with named fields identical to the names of the object attributes.

With no arguments, the newly created filter will be empty.

init

Initialize object attributes and then lock them down to prevent accidental creation of new ones.

Note: there is no leading underscore on name "init", though it's arguably an "internal" routine (i.e. not likely to be of use to client code).

save

Given a filter "saves" it in memory.

Returns the ref to the filter object.

lookup
list_filters

Returns a list of all avaliable named filters.

special accessors (access the "extra" namespace)

filter_data

Getter for object attribute filter_data

set_filter_data

Setter for object attribute set_filter_data

basic accessors (defined in List::Filter::StorageBase);

connect_to

Getter for object attribute connect_to

set_connect_to

Setter for object attribute set_connect_to

owner

Getter for object attribute owner

set_owner

Setter for object attribute set_owner

password

Getter for object attribute password

set_password

Setter for object attribute set_password

attributes

Getter for object attribute attributes

set_attributes

Setter for object attribute set_attributes

extra

Getter for object attribute extra

set_extra

Setter for object attribute set_extra

SEE ALSO

Top

List::Filter

AUTHOR

Top

Joseph Brenner, <doom@kzsu.stanford.edu>, 18 May 2007

COPYRIGHT AND LICENSE

Top

BUGS

Top

None reported... yet.


List-Filter documentation  | view source Contained in the List-Filter distribution.