Add deprecation warnings to Reflex::Handle and its subclasses.

rcaputo · Jul 1, 2010 · 156542b · 156542b
1 parent a6d52ce
commit 156542b
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/lib/Reflex/Client.pm b/lib/Reflex/Client.pm
@@ -120,6 +120,14 @@ eg/eg-35-tcp-client.pl available at the time of this writing.
 
 =head1 DESCRIPTION
 
+Reflex::Client is scheduled for substantial changes.  One of its base
+classes, Reflex::Handle, will be deprecated in favor of
+Reflex::Role::Readable and Reflex::Role::Writable.  Hopefully
+Reflex::Client's interfaces won't change much as a result, but
+there are no guarantees.
+Your ideas and feedback for Reflex::Client's future implementation
+are welcome.
+
 Reflex::Client is a high-level base class for non-blocking socket
 clients.  As with other Reflex::Base classes, this one may be
 subclassed, composed with "has", or driven inline with promises.

diff --git a/lib/Reflex/Connector.pm b/lib/Reflex/Connector.pm
@@ -142,6 +142,14 @@ eg/eg-38-promise-client.pl in the distribution.
 
 =head1 DESCRIPTION
 
+Reflex::Connector is scheduled for substantial changes.  Its base
+class, Reflex::Handle, will be deprecated in favor of
+Reflex::Role::Readable and Reflex::Role::Writable.  Hopefully
+Reflex::Connector's interfaces won't change much as a result, but
+there are no guarantees.
+Your ideas and feedback for Reflex::Connector's future implementation
+are welcome.
+
 Reflex::Connector performs a non-blocking connect() object on a plain
 socket.  It extends Reflex::Handle to wait for the connection without
 blocking the rest of a program.

diff --git a/lib/Reflex/Handle.pm b/lib/Reflex/Handle.pm
@@ -180,6 +180,11 @@ Reflex::Handle - Watch a filehandle for read- and/or writability.
 
 =head1 DESCRIPTION
 
+Reflex::Handle is scheduled to be deprecated.
+Please see Reflex::Role::Readable and Reflex::Role::Writable, which
+allow the creation of read- and write-only classes.
+Your ideas and feedback for Reflex::Handle's replacement are welcome.
+
 Reflex::Handle watches a filehandle and emits events when it has data
 to be read, is ready to be written upon, or has some exceptional
 condition to be addressed.

diff --git a/lib/Reflex/Listener.pm b/lib/Reflex/Listener.pm
@@ -76,6 +76,14 @@ Reflex::Listener - Generate connected client sockets from a listening server soc
 
 =head1 DESCRIPTION
 
+Reflex::Listener is scheduled for substantial changes.  Its base
+class, Reflex::Handle, will be deprecated in favor of
+Reflex::Role::Readable and Reflex::Role::Writable.  Hopefully
+Reflex::Listener's interfaces won't change much as a result, but
+there are no guarantees.
+Your ideas and feedback for Reflex::Listener's future implementation
+are welcome.
+
 Reflex::Listener extends Reflex::Handle.  It watches listening server
 sockets for new client connections.  When they arrive, it accept()s
 them and emits them in "accepted" events.