NAME

perfSONAR_PS::Messages - A module that provides common methods for performing actions on message constructs.

DESCRIPTION

This module is a catch all for message related methods in the perfSONAR-PS framework. As such there is no 'common thread' that each method shares. This module IS NOT an object, and the methods can be invoked directly (and sparingly).

startMessage($output, $id, $messageIdRef, $type, $content, $namespaces)

Start message element.

endMessage($output)

End message element.

startMetadata($output, $id, $metadataIdRef, $namespaces)

Start a metadata element.

endMetadata($output)

End a metadata element.

startData($output, $id, $metadataIdRef, $namespaces)

Start a data element.

endData($output)

End a data element

startParameters($output)

Start a parameters element.

endParameters($output)

End a parameters element.

addParameter($output, $name, $value, $args)

Add a parameter element, returns the results.

getResultCodeMessage($output, $id, $messageIdRef, $metadataIdRef, $type, $event, $description, $namespaces, $escape_content)

Create an entire result code message.

getResultCodeMetadata($output, $id, $metadataIdRef, $event)

Create a metadata element to pair with a result code.

getResultCodeData($output, $id, $metadataIdRef, $description, $escape_content)

Create a data element for a result code.

statusReport($output, $mdId, $mdIdRef, $dId, $eventType, $msg)

Create a 'status' pair of data and metadata.

createMessage($output, $id, $messageIdRef, $type, $content, $namespaces)

Craft a message element.

createMetadata($output, $id, $metadataIdRef, $content, $namespaces)

Craft a metadata element.

createData($output, $id, $metadataIdRef, $content, $namespaces)

Craft a data element.

getErrorResponseMessage({ output, id, messageIdRef, metadataIdRef, eventType, description });

Craft an error response message.

XXX: Jason 3/12/08 - Document_string is still used here.

SEE ALSO

Exporter, Log::Log4perl, perfSONAR_PS::Common, perfSONAR_PS::ParameterValidation

To join the 'perfSONAR-PS' mailing list, please visit:

https://mail.internet2.edu/wws/info/i2-perfsonar

The perfSONAR-PS subversion repository is located at:

https://svn.internet2.edu/svn/perfSONAR-PS 

Questions and comments can be directed to the author, or the mailing list.

VERSION

$Id$

AUTHOR

Jason Zurawski, zurawski@internet2.edu

LICENSE

You should have received a copy of the Internet2 Intellectual Property Framework along with this software. If not, see <http://www.internet2.edu/membership/ip.html>

COPYRIGHT

Copyright (c) 2004-2008, Internet2 and the University of Delaware

All rights reserved.

cpanm perfSONAR_PS::Time

perl -MCPAN -e shell
install perfSONAR_PS::Time