Code Index:

package App::MessageDispatcher
EOF

NAME

App::MessageDispatcher - Interface for sending/receiving (possibly) async messages

SYNOPSIS

    use App;

    $context = App->context();
    $messaging = $context->service("MessageDispatcher");  # or ...
    $messaging = $context->messaging();

    ($status, $ticket) = $messaging->send(
        recipient => $recipient,
        message => $message
    );

    $message = $messaging->receive();

    $message = $messaging->receive(
        sender => $sender,
    );

    $message = $messaging->receive(
        ticket => $ticket,
    );

DESCRIPTION

A MessageDispatcher service is a means by which data can be sent asynchronously (or synchronously) to a recipient and responses can be received.

Because the possibility exists for the messaging channel to be asynchronous, code that uses a MessageDispatcher service must code for the most complicated case (asynchronous).

Class Group: MessageDispatcher

The following classes might be a part of the MessageDispatcher Class Group.

* Class: App::MessageDispatcher
* Class: App::MessageDispatcher::Mail
* Class: App::MessageDispatcher::SOAP
* Class: App::MessageDispatcher::Stem
* Class: App::MessageDispatcher::Spread
* Class: App::MessageDispatcher::Jabber
* Class: App::MessageDispatcher::PVM
* Class: App::MessageDispatcher::MPI

Class: App::MessageDispatcher

A MessageDispatcher service is a means by which data can be sent synchronously or asynchronously to a recipient and responses can be received.

 * Throws: App::Exception::MessageDispatcher
 * Since:  0.01

Class Design

...

Constructor Methods:

new()

The constructor is inherited from App::Service|App::Service/"new()".

Public Methods:

send()

    * Signature: ($status, $ticket) = $messaging->send(%named);
    * Param:     recipient          string
    * Param:     message            binary
    * Return:    $status            integer
    * Return:    $ticket            string
    * Throws:    App::Exception::MessageDispatcher
    * Since:     0.01

    Sample Usage: 

    ($status, $ticket) = $messaging->send(
        recipient => "spadkins\@gmail.com",
        message => "Hello.",
    );

receive()

    * Signature: $message = $messaging->receive();
    * Signature: $message = $messaging->receive(%named);
    * Param:     sender          string
    * Param:     ticket          string
    * Return:    $message        binary
    * Throws:    App::Exception::MessageDispatcher
    * Since:     0.01

    Sample Usage: 

    # receive next available message
    $message = $messaging->receive();

    # receive next message from sender
    $message = $messaging->receive(
        sender => "spadkins\@gmail.com",
    );

    # receive message associated with ticket
    $message = $messaging->receive(
        ticket => "XP305-3jks37sl.f299d",
    );

Protected Methods:

service_type()

Returns 'MessageDispatcher'.

    * Signature: $service_type = App::MessageDispatcher->service_type();
    * Param:     void
    * Return:    $service_type  string
    * Since:     0.01

    $service_type = $mdisp->service_type();

ACKNOWLEDGEMENTS

 * Author:  Stephen Adkins <spadkins@gmail.com>
 * License: This is free software. It is licensed under the same terms as Perl itself.