NAME
POE::Component::PubSub::Event - An event abstraction for POE::Component::PubSub
VERSION
version 0.091370
DESCRIPTION
POE::Component::PubSub::Event is a simple abstraction for published and subscribed events within PubSub. When using the find_event method or the listing method from PubSub, you will receive this object.
ATTRIBUTES
name
The name of the event.
subscribers, predicate => 'has_subscribers', clearer => 'clear_subscribers
The event's subscribers stored in a Set::Object
publisher, predicate => 'has_publisher'
The event's publisher.
publishtype, isa => PublishType
The event's publish type.
input, predicate => 'has_input'
If the publishtype is set to PUBLISH_INPUT, this will indicate the input handling event that belongs to the publisher
METHODS
all_subscribers()
This method is delegated to the subscribers attribute to return all of the subscribers for this event
add_subscriber(Subscriber $sub)
Add the supplied subscriber to the event
remove_subscriber(Subscriber $sub)
Remove the supplied subscriber from the event
find_subscriber(SessionID $session) returns (Maybe[Subscriber])
This method will search for a particular subscriber by their SessionID. Returns undef if none was found.
AUTHOR
Nicholas Perez <nperez@cpan.org>COPYRIGHT AND LICENSE
This software is Copyright (c) 2009 by Nicholas Perez.
This is free software, licensed under:
The GNU General Public License, Version 3, June 2007