NAME

MOSES::MOBY::Async - A module for interacting with HTTP POST WSRF asynchronous services

SYNOPSIS

 use MOSES::MOBY::Async;

DESCRIPTION

This module is the main module used by asynchronous HTTP POST biomoby services. In most situations, it would be incorrect for you to instantiate a reference to this module.

AUTHORS

 Edward Kawas (edward.kawas [at] gmail [dot] com)

ACCESSIBLE ATTRIBUTES

Details are in MOSES::MOBY::Base. Here just a list of them (additionally to the attributes from the parent classes)

The following are constants that refer to faults.

none are exported

RESOURCE_UNKNOWN_FAULT
RESOURCE_UNAVAILABLE_FAULT
RESOURCE_NOT_DESTROYED_FAULT
INVALID_RESOURCE_PROPERTY_QNAME_FAULT

 Name       :    submit
 Function   :    submits an asynchronous job
 Usage      :    $async->submit($obj, $id, $job, $in_package, $out_package);
 Args       :    $obj         - a child of MOSES::MOBY::Service::ServiceBase
                 $id          - a scalar string representing the service invocation id
                 $job         - a MOSES::MOBY::Job, representing the current job 
                 $in_package  - a MOSES::MOBY::Package, representing the incoming message 
                 $out_package - a MOSES::MOBY::Package, representing the outgoing message

 Name       :    destroy
 Function   :    destroys an asynchronous job
 Usage      :    $async->destroy($header, $data);
 Args       :    $header - a string of XML representing the moby-wsrf header 
                 $data   - a string of XML representing the WSRF destroy resource call.

 Name       :    result
 Function   :    obtains the result of an asynchronous job
 Usage      :    $async->result($header, $data);
 Args       :    $header - a string of XML representing the moby-wsrf header 
                 $data   - a string of XML representing the WSRF result call.

 Name       :    poll
 Function   :    polls the status of an asynchronous job
 Usage      :    $async->poll($header, $data);
 Args       :    $header - a string of XML representing the moby-wsrf header 
                 $data   - a string of XML representing the WSRF poll resource status call.

 Name       :    create_epr
 Function   :    creates an endpoint reference for the given CGI object
 Usage      :    $async->create_epr($cgi);
 Args       :    $cgi - a CGI variable

 Name       :    create_fault
 Function   :    creates a WSRF resource fault
 Usage      :    $async->create_fault($fault_type, $url);
 Args       :    $fault_type - one of C<RESOURCE_UNKNOWN_FAULT>, C<RESOURCE_UNAVAILABLE_FAULT>, C<RESOURCE_NOT_DESTROYED_FAULT> or C<INVALID_RESOURCE_PROPERTY_QNAME_FAULT> 
                 $url        - the service url
                 $desc           - an optional message to include in the fault.