1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | NAME IPC::PubSub - Interprocess Publish/Subscribe channels SYNOPSIS # A new message bus with the DBM::Deep backend # (Other possible backends include Memcached and PlainHash) my $bus = IPC::PubSub->new(DBM_Deep => '/tmp/pubsub.db'); # A channel is any arbitrary string my $channel = '#perl6'; # Register a new publisher (you can publish to multiple channels) my $pub = $bus->new_publisher("#perl6", "#moose"); # Publish a message (may be a complex object) to those channels $pub->msg("This is a message"); # Register a new subscriber (you can subscribe to multiple channels) my $sub = $bus->new_subscriber("#moose"); # Publish an object to channels $pub->msg("This is another message"); # Set all subsequent messages from this publisher to expire in 30 seconds $pub->expiry(30); $pub->msg("This message will go away in 30 seconds"); # Simple get: Returns the messages sent since the previous get, # but only for the first channel. my @msgs = $sub->get; # Simple get, with an explicit channel key (must be among the ones # it initially subscribed to) my @moose_msgs = $sub->get("#moose"); # Complex get: Returns a hash reference from channels to array # references of [timestamp, message]. my $hash_ref = $sub->get_all; # Changing the list of channels we subscribe to $sub->subscribe('some-other-channel'); $sub->unsubscribe('some-other-channel'); # Changing the list of channels we publish to $pub->publish('some-other-channel'); $pub->unpublish('some-other-channel'); # Listing and checking if we are in a channel my @sub_channels = $sub->channels; my @pub_channels = $pub->channels; print "Sub is in #moose" if $sub->channels->{'#moose'}; print "Pub is in #moose" if $pub->channels->{'#moose'}; # Raw cache manipulation APIs (not advised; use ->modify instead) $bus->lock('channel'); $bus->unlock('channel'); my @timed_msgs = $bus->fetch('key1', 'key2', 'key3'); $bus->store('key', 'value', time, 30); # Atomic updating of cache content; $_ is stored back on the # end of the callback. my $rv = $bus->modify('key' => sub { delete $_->{foo} }); # Shorthand for $bus->modify('key' => sub { $_ = 'val' }); $bus->modify('key' => 'val'); # Shorthand for $bus->modify('key' => sub { $_ }); $bus->modify('key'); # Disconnect the backend connection explicitly $bus->disconnect; DESCRIPTION This module provides a simple API for publishing messages to *channels* and for subscribing to them. When a *message* is published on a channel, all subscribers currently in that channel will get it on their next "get" or "get_all" call. Currently, it offers three backends: "DBM_Deep" for on-disk storage, "Memcached" for possibly multi-host storage, and "PlainHash" for single-process storage. Please see the tests in t/ for this distribution, as well as "SYNOPSIS" above, for some usage examples; detailed documentation is not yet available. SEE ALSO IPC::DirQueue, where the subscribers divide the published messages among themselves, so different subscribers never see the same message. AUTHORS Audrey Tang <cpan@audreyt.org> COPYRIGHT Copyright 2006, 2007 by Audrey Tang <cpan@audreyt.org>. This software is released under the MIT license cited below. The "MIT" License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
Commit History @fdd3ab85-4cda-4df2-8cab-9bea81072a0d/main
0
»»
- Remove AGOSTINI Yves from Uploaders. Thanks for your work! gregor herrmann 7 years ago
- update changelog Salvatore Bonaccorso 8 years ago
- debian/control: Use HTTPS transport protocol for Vcs-Git URI Salvatore Bonaccorso 8 years ago
- update changelog Salvatore Bonaccorso 9 years ago
- Update Vcs-Browser URL to cgit web frontend Salvatore Bonaccorso 9 years ago
- update changelog gregor herrmann 10 years ago
- Strip trailing slash from metacpan URLs. gregor herrmann 10 years ago
- update changelog Salvatore Bonaccorso 11 years ago
- Change search.cpan.org based URIs to metacpan.org based URIs Salvatore Bonaccorso 11 years ago
- update changelog Salvatore Bonaccorso 11 years ago
- Change Vcs-Git to canonical URI (git://anonscm.debian.org) Salvatore Bonaccorso 11 years ago
- update changelog gregor herrmann 11 years ago
- debian/control: update {versioned,alternative} (build) dependencies. gregor herrmann 11 years ago
- debian/control: Convert Vcs-* fields to Git. Ansgar Burchardt 12 years ago
- clean up duplicated changelog entries from nhandler's mass-commit Ryan Niebur 14 years ago
- [mass-commit] debian/watch: Modify to ignore development releases. Nathan Handler 14 years ago
- Set debhelper compatibility level to 7; adapt Gregor Herrmann 15 years ago
- * s/UNRELEASED/unstable/ Yves Agostini 15 years ago
- * newrelease Yves Agostini 15 years ago
- [svn-upgrade] Integrating new upstream version, libipc-pubsub-perl (0.29) Yves Agostini 15 years ago
- move TODO to the top of changelog Gregor Herrmann 15 years ago
- [mass commit] switch Vcs-Browser from from WebSVN to ViewSVN Gregor Herrmann 15 years ago
- * new upstream release Yves Agostini 15 years ago
- [svn-upgrade] Integrating new upstream version, libipc-pubsub-perl (0.28) Yves Agostini 15 years ago
- add dh_installdocs again Gregor Herrmann 16 years ago
- * add name in description Yves Agostini 16 years ago
- [svn-inject] Applying Debian modifications to trunk Yves Agostini 16 years ago
- [svn-inject] Installing original source of libipc-pubsub-perl Yves Agostini 16 years ago
0
»»