further detail OR->connect arguments, and document other bits

[scpubgit/Object-Remote.git] / lib / Object / Remote / Node.pm

diff --git a/lib/Object/Remote/Node.pm b/lib/Object/Remote/Node.pm
index a790ba8..f6d05ca 100644 (file)
--- a/lib/Object/Remote/Node.pm
+++ b/lib/Object/Remote/Node.pm
@@ -5,29 +5,32 @@ use Object::Remote::Connector::STDIO;
 use Object::Remote::Logging qw(:log :dlog);
 use Object::Remote::WatchDog;
 use Object::Remote;
-use CPS::Future;
 
 sub run {
-  my ($class, %args) = @_; 
+  my ($class, %args) = @_;
   log_trace { "run() has been invoked on remote node" };
-    
+
   my $c = Object::Remote::Connector::STDIO->new->connect;
-  
+
   $c->register_class_call_handler;
 
   my $loop = Object::Remote->current_loop;
-  
-  $c->on_close->on_ready(sub { 
-    log_info { "Node connection with call handler has closed" };
-    $loop->want_stop 
+
+  $c->on_close->on_ready(sub {
+    log_debug { "Node connection with call handler has closed" };
+    $loop->want_stop
   });
 
   Dlog_trace { "Node is sending 'Shere' to $_" } $c->send_to_fh;
   print { $c->send_to_fh } "Shere\n";
 
   log_debug { "Node is going to start the run loop" };
+  #TODO the alarm should be reset after the run loop starts
+  #at a minimum - the remote side node should probably send
+  #a command that clears the alarm in all instances - even
+  #if the Object::Remote::Watchdog is not being used
   if ($args{watchdog_timeout}) {
-    Object::Remote::WatchDog->new(timeout => $args{watchdog_timeout});
+    Object::Remote::WatchDog->instance(timeout => $args{watchdog_timeout});
   } else {
     #reset connection watchdog from the fatnode
     alarm(0);
@@ -38,3 +41,30 @@ sub run {
 }
 
 1;
+
+=head1 NAME
+
+Object::Remote::Node - A minimum remote OR command processing loop
+
+=head1 SYNOPSIS
+
+  use Object::Remote::Node;
+  
+  Object::Remote::Node->run(%args);
+
+=head1 DESCRIPTION
+
+The minimum amount of code necessary to read OR JSON commands from STDIN and
+send responses to STDOUT after processing. Uses
+L<Object::Remote::Connector::STDIO>.
+
+=head1 ARGUMENTS
+
+=head2 watchdog_timeout
+
+If provided sets up a L<Object::Remote::WatchDog> with the timeout set to the
+value in seconds specified by this argument.
+
+If not provided or undef/0, attempts to cancel any existing watch dogs. ???
+
+=cut