1POE::Component::Server:U:sBearyeCuoxn:t:rCilbiuetnetdP(O3PE)e:r:lCoDmopcounmeenntt:a:tSieornver::Bayeux::Client(3)
2
3
4
6 POE::Component::Server::Bayeux::Client - An object representing a
7 single client of the server
8
10 Used internally by POE::Component::Server::Bayeux.
11
13 new (...)
14 Arguments:
15
16 server_heap (required)
17 The server's heap object
18
19 request
20 A POE::Component::Server::Bayeux::Request object representing
21 an HTTP-connected client.
22
23 id The clientId. If not given, generates one using Data::UUID.
24
25 session
26 For locally connected clients, the POE session alias or ID to
27 post back to.
28
30 disconnect ()
31 complete_poll ()
32 Completes an active poll if there is one
33
34 message_acl ($message)
35 Called with a POE::Component::Server::Bayeux::Message, the client
36 is to evaluate wether the message is invalid within the context of
37 the client - as in, perform an authorization check. If there's an
38 error, the message will have it's is_error() field set with the
39 error.
40
41 is_subscribed ($channel)
42 Returns boolean of wether the client is subscribed to the literal
43 channel provided
44
45 send_message ($message, $subscription_args)
46 Sends, or queues, the message to the client. $subscription_args is
47 the same hashref that was passed to the server's subscribe() method
48 when this client subscribed to the channel. Structure of the
49 message is same as Bayeux '5.2. Deliver Event message'.
50
51 check_timeout ()
52 Checks last time HTTP-connected client performed connected, and
53 removes client if it's stale (according to server arg
54 ConnectTimeout).
55
56 flush_queue ()
57 Flush the queue of messages, if there is any, and only if client is
58 currently connected. Only used for HTTP-connected clients.
59
60 logger ()
61 Return a reference to the servers logger.
62
63 server_config ()
64 Returns the server's args
65
67 Copyright (c) 2008 Eric Waters and XMission LLC
68 (http://www.xmission.com/). All rights reserved. This program is free
69 software; you can redistribute it and/or modify it under the same terms
70 as Perl itself.
71
72 The full text of the license can be found in the LICENSE file included
73 with this module.
74
76 Eric Waters <ewaters@uarc.com>
77
78
79
80perl v5.28.1 2019P-O0E2:-:1C1omponent::Server::Bayeux::Client(3)