| Subject: | [PATCH] Add documentation of 'connect' event to Client::TCP |
Po::Co::Client::TCP
Adds some missing documentation of the 'connect' event, to describe the behaviour allowing this event to be used to alter the target host and port of Client::TCP.
If the lameness factor of this patch is high, mail me with comments and I'll keep trying 'till I get somthing that reads well.
Corwin
--- /usr/local/lib/perl5/site_perl/5.8.0/POE/Component/Client/TCP.pm Tue Nov 25 21:52:07 2003
+++ TCP.pm Mon Feb 2 15:28:34 2004
@@ -389,8 +389,12 @@
# Accepted public events.
- $kernel->yield( "shutdown" ) # shut down a connection
- $kernel->yield( "reconnect" ) # reconnect to a server
+ # shut down a connection
+ $kernel->yield( "shutdown" )
+ # reconnect to a server
+ $kernel->yield( "reconnect" )
+ # connect, optionaly to a new host and/or port
+ $kernel->yield( "connect", $new_host, $new_port )
# Responding to a server.
@@ -626,6 +630,13 @@
graceful shutdown. Any subsequent server input will be ignored, and
any pending output data will be flushed. Once the connection is dealt
with, the component will self-destruct.
+
+=item connect
+
+Cause the TCP client to connect, optionaly providing a new RemoteHost
+and RemotePort (which will be used for subsiquent calls to
+'reconnect'). If the server is already connected it will disconnect
+harshly, as with reconnect, discarding any pending input or output.
=back