1POE::Component::Server:U:sBearyeCuoxn:t:rMiebsustaePgdOeE(P:3e:)rClomDpoocnuemnetn:t:aSteirovner::Bayeux::Message(3)
2
3
4

NAME

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

DESCRIPTION

10       Used internally by POE::Component::Server::Bayeux::Request.
11
12       This is the parent class of the different message types (Meta, Service,
13       Publish, by default).  Each message can override or call via SUPER the
14       object methods here.
15

METHODS

17   Accessors
18           Accessors to this objects hashref.
19
20           is_error
21           request
22
23   Data Accessors
24           These access the named field in the message payload
25
26           channel
27           version
28           minimumVersion
29           supportedConnectionTypes
30           clientId
31           advice
32           connectionType
33           id
34           timestamp
35           data
36           connectionId
37           successful
38           subscription
39           error
40           ext
41
42   server_config ()
43           Returns the server's args
44
45   pre_handle ()
46           Called by the request before handle().  Enables the message to
47           affect the queueing of the other messages in the request, or do
48           anything else it wants.
49
50   handle ()
51           At a minimum, validates the fields of the message payload.  A
52           message will usually add a response in this block:
53
54             $message->request->add_response({ successful => 1 });
55
56   post_handle ()
57           Like pre_handle(), but called after the handle() phase.
58
59   validate_fields (%spec)
60           Given a Params::Validate spec, will test the payload for validity.
61           Failure causes an error message stored in is_error().
62

CLASS METHODS

64   new (..)
65           Basic new() call, needs only 'request' and 'data'.
66
67   payload
68           Returns the message payload
69
70   mk_data_accessors (@method_names)
71           Generates object accessor methods for the named methods.
72           Supplements the generic methods that are created for all message
73           types.
74

76       Copyright (c) 2008 Eric Waters and XMission LLC
77       (http://www.xmission.com/).  All rights reserved.  This program is free
78       software; you can redistribute it and/or modify it under the same terms
79       as Perl itself.
80
81       The full text of the license can be found in the LICENSE file included
82       with this module.
83

AUTHOR

85       Eric Waters <ewaters@uarc.com>
86
87
88
89perl v5.32.0                      202P0O-E0:7:-C2o8mponent::Server::Bayeux::Message(3)
Impressum