/ 
POE-Component-Server-Bayeux-0.04
River stage one • 1 direct dependent • 1 total dependent
/ POE::Component::Server::Bayeux::Message

NAME

POE::Component::Server::Bayeux::Client::Message - An object representing a single message of a request

DESCRIPTION

Used internally by POE::Component::Server::Bayeux::Request.

This is the parent class of the different message types (Meta, Service, Publish, by default). Each message can override or call via SUPER the object methods here.

METHODS

Accessors

    Accessors to this objects hashref.

    is_error
    request

Data Accessors

    These access the named field in the message payload

    channel
    version
    minimumVersion
    supportedConnectionTypes
    clientId
    advice
    connectionType
    id
    timestamp
    data
    connectionId
    successful
    subscription
    error
    ext

server_config ()

    Returns the server's args

pre_handle ()

    Called by the request before handle(). Enables the message to affect the queueing of the other messages in the request, or do anything else it wants.

handle ()

    At a minimum, validates the fields of the message payload. A message will usually add a response in this block:

    $message->request->add_response({ successful => 1 });

post_handle ()

    Like pre_handle(), but called after the handle() phase.

validate_fields (%spec)

    Given a Params::Validate spec, will test the payload for validity. Failure causes an error message stored in is_error().

CLASS METHODS

new (..)

    Basic new() call, needs only 'request' and 'data'.

payload

    Returns the message payload

mk_data_accessors (@method_names)

    Generates object accessor methods for the named methods. Supplements the generic methods that are created for all message types.

COPYRIGHT

Copyright (c) 2008 Eric Waters and XMission LLC (http://www.xmission.com/). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

AUTHOR

Eric Waters <ewaters@uarc.com>