Pots::Message - Perl ObjectThreads message class


Pots documentation  | view source Contained in the Pots distribution.

Index


NAME

Top

Pots::Message - Perl ObjectThreads message class

SYNOPSIS

Top

    use Pots::Message;

    my $msg = Pots::Message->new();
    $msg->type('MyMessage');
    $msg->set('key1', $data1);

    my $msg = Pots::Message->new(
        'MyMessage',
        {
            'key1' => $data1,
        }
    );

DESCRIPTION

Top

This class allows you to store arbitrary data in an object and is very similar in purpose to a standard Perl hash. It is the base element for data exchange between threads along with Pots::MessageQueue.

METHODS

Top

new ([$type] [, {'key' => $value, ...}])

This method creates a new message object. You can optionaly set message content (message type and message data).

type ($type)

Sets message type (arbitrary string) so that you can later filter messages.

set ('key', $value)

Add arbitrary data to the message, identified by 'key'.

get ('key')

Retrieves data stored in the message, identified by 'key'.

AUTHOR and COPYRIGHT

Top


Pots documentation  | view source Contained in the Pots distribution.