View on
MetaCPAN
Dale Amon > Fault-1.01-2 > Fault::Delegate::List

Download:
Fault-1.01-2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

 Fault::Delegate::List - Internal class for managing a list of delegates.

SYNOPSIS ^

 use Fault::Delegate::List;
 $self      = Fault::Delegate::List->new (@delegates);
 $bool      = $self->add                 (@delegates);
 @delegates = $self->delegates;
 $bool      = $self->log                 ($msg,@rest);
 $bool      = $self->trans00             ($msg,@rest);
 $bool      = $self->trans01             ($msg,@rest);
 $bool      = $self->trans10             ($msg,@rest);
 $bool      = $self->trans11             ($msg,@rest);

Inheritance ^

 UNIVERSAL

Description ^

 Internal class for managing a list of delegates.

Examples ^

 None.

Class Variables ^

 None.

Instance Variables ^

 list      Contains a pointer to a hash of delegate pointers.

Class Methods ^

$self = Fault::Delegate::List->new(@delegates)

Create an instance of Fault::Delegate::List and initialize it with the contents of @delegates. The list may be null.

If a delegate has an initfaults method, it is executed and the results merged into the current list of active faults.

Instance Methods ^

$bool = $self->add (@delegates)

Add each member of a list of delegates, that is not already present, to the internal list of delegates. The list may be empty.

A member of the list is included only if it is a pointer to an object that has a log method.

If a delegate has an initfaults method, it is executed and the results merged into the current list of active faults.

@delegates = $self->delegates

Returns a list of delegate objects suitable for iteration. The list may be empty.

$bool = $self->log ($msg,@rest)

Send a message to each delegate for logging.

$bool = $self->trans00 ($msg,@rest)

Send a message to each delegate for 4 state fault monitoring in the case that $msg was in a Fault Clear state previously and still is.

$bool = $self->trans01 ($msg,@rest)

Send a message to each delegate for 4 state fault monitoring in the case that $msg was in a Fault Clear state previously and is now in a Fault Raised state.

$bool = $self->trans10 ($msg,@rest)

Send a message to each delegate for 4 state fault monitoring in the case that $msg was in a Fault Raised state previously but is now in a Fault Clear state.

$bool = $self->trans11 ($msg,@rest)

Send a message to each delegate for 4 state fault monitoring in the case that $msg was in a Fault Raised state previously and still is.

@faults = $self->initfaults

Ask each delegate to return a current list of faults for this process from its persistant storage. Returns an empty list if there are none or the delegate class has no such memory or if it does and is unable to retrieve data from it.

Private Class Method ^

 None.

Private Instance Methods ^

 None.

Errors and Warnings ^

 None.

KNOWN BUGS ^

 See TODO.

SEE ALSO ^

 None.

AUTHOR ^

Dale Amon <amon@vnl.com>

syntax highlighting: