[SCM] libmessage-passing-perl Debian packaging branch, master, updated. debian/0.111-3-14-g44f6e88
Tomas Doran
bobtfish at bobtfish.net
Mon May 6 11:57:13 UTC 2013
The following commit has been merged in the master branch:
commit 246b3dff6c6e1c5d62dfdff9cc1e3414a9c5b224
Author: Tomas Doran <bobtfish at bobtfish.net>
Date: Sun Jun 10 17:41:10 2012 +0100
Actually document subscribe_to_connect method
diff --git a/TODO b/TODO
index 7c8dbe9..7bd828d 100644
--- a/TODO
+++ b/TODO
@@ -16,7 +16,7 @@ Specific adaptors
Docs:
Role::ConnectionManager
- - Fix docs
+ - Fix timeouts and reconnects doc
Role::HasAconnection
- Fix docs
diff --git a/lib/Message/Passing/Role/ConnectionManager.pm b/lib/Message/Passing/Role/ConnectionManager.pm
index 1f85f7d..f01b309 100644
--- a/lib/Message/Passing/Role/ConnectionManager.pm
+++ b/lib/Message/Passing/Role/ConnectionManager.pm
@@ -175,8 +175,17 @@ be undefined if we are during a reconnect timeout.
=head1 METHODS
-=head2 subscribe_to_connect
+=head2 subscribe_to_connect ($subscriber)
+This is called by your Input or Output, as C<< $self->connection_manager->subscribe_to_connect($self) >>.
+This is done for you by L<Message::Passing::Role::HasAConnection> usually..
+
+This arranges to store a weak reference to your component, allowing the conenction manager to call the C<< ->connect >>
+or C<< ->disconnect >> methods for any components registered when a connection is established or destroyed.
+
+Note that if the connection manager is already connected, it will B<immediately> call the C<< ->connect >> method.
+
+=head1 TIMEOUTS AND RECONNECTS
=cut
--
libmessage-passing-perl Debian packaging
More information about the Pkg-perl-cvs-commits
mailing list