1POE::Component::Server:U:sBearyeCuoxn:t:rRiebquuteePsdOtE(P:3e:)rClomDpoocnuemnetn:t:aSteirovner::Bayeux::Request(3)
2
3
4
6 POE::Component::Server::Bayeux::Request - A single Bayeux request
7
9 Objects in this class represent a single Bayeux request made to a
10 Bayeux server. Requests are instantiated with an HTTP::Request and
11 HTTP::Response object. This class is responsible for parsing the
12 request content into a JSON object, creating one or more
13 POE::Component::Server::Bayeux::Message objects that represent the
14 possible message types of the Bayeux protocol, and handling each one in
15 turn.
16
18 new ()
19 Requires 'request' (POE::Component::Server::HTTP::Request),
20 'response' (POE::Component::Server::HTTP::Response), and
21 'server_heap'. Returns init()'ed class object.
22
24 handle ()
25 Call after creating the request. Calls the pre_handle(), handle()
26 methods on each message, possibly completing the request.
27
28 complete ()
29 Completes the request, calling the post_handle() method on the
30 messages that need it.
31
33 These methods are mainly called by messages during their handle()
34 phase.
35
36 client ($id)
37 Returns a POE::Component::Server::Bayeux::Client object with the
38 given id.
39
40 add_response ($response)
41 Adds a message response onto the stack of responses.
42
43 clear_stack ()
44 Clears all messages and responses.
45
46 add_post_handle ($message)
47 Adds a message to be handled in the post_handle() code.
48
49 init ()
50 Parses the POE::Component::Server::HTTP::Request object, extracting
51 the JSON payload, creating a stack of
52 POE::Component::Server::Bayeux::Message messages.
53
54 error ($message)
55 Convienence method to throw an error, returning to the client.
56
57 form_response (@messages)
58 Encodes the messages into the payload of the response
59
60 logger ()
61 Returns the server's logger.
62
63 subscribe ($client_id, $channel)
64 Passthru to the POE server's subscribe state
65
66 unsubscribe ($client_id, $channel)
67 Passthru to the POE server's unsubscribe state
68
69 publish ($client_id, $channel, $data)
70 Passthru to the POE server's publish state
71
73 Copyright (c) 2008 Eric Waters and XMission LLC
74 (http://www.xmission.com/). All rights reserved. This program is free
75 software; you can redistribute it and/or modify it under the same terms
76 as Perl itself.
77
78 The full text of the license can be found in the LICENSE file included
79 with this module.
80
82 Eric Waters <ewaters@uarc.com>
83
84
85
86perl v5.28.1 201P9O-E0:2:-C1o1mponent::Server::Bayeux::Request(3)