allow scalar refs to be transferred
[scpubgit/Object-Remote.git] / lib / Object / Remote / Connection.pm
index a5ad302..4d593b3 100644 (file)
@@ -35,20 +35,21 @@ has on_close => (is => 'rw', default => sub { CPS::Future->new });
 
 has child_pid => (is => 'ro');
 
-has is_ready => (is => 'rwp', trigger => sub {
-  my ($self, $value) = @_;
-  $self->ready_future->done if $value;
-});
-
 has ready_future => (is => 'lazy');
 
 sub _build_ready_future { CPS::Future->new }
 
 has _receive_data_buffer => (is => 'ro', default => sub { my $x = ''; \$x });
 
-has local_objects_by_id => (is => 'ro', default => sub { {} });
+has local_objects_by_id => (
+  is => 'ro', default => sub { {} },
+  coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in
+);
 
-has remote_objects_by_id => (is => 'ro', default => sub { {} });
+has remote_objects_by_id => (
+  is => 'ro', default => sub { {} },
+  coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in
+);
 
 has outstanding_futures => (is => 'ro', default => sub { {} });
 
@@ -80,6 +81,11 @@ sub _build__json {
       my $code_container = $self->_id_to_remote_object(@_);
       sub { $code_container->call(@_) };
     }
+  )->filter_json_single_key_object(
+    __scalar_ref__ => sub {
+      my $value = shift;
+      return \$value;
+    }
   );
 }
 
@@ -88,6 +94,7 @@ BEGIN {
   eval { require Object::Remote::Connector::Local };
   eval { require Object::Remote::Connector::LocalSudo };
   eval { require Object::Remote::Connector::SSH };
+  eval { require Object::Remote::Connector::UNIX };
 }
 
 sub new_from_spec {
@@ -99,13 +106,49 @@ sub new_from_spec {
   die "Couldn't figure out what to do with ${spec}";
 }
 
-sub new_remote {
+sub remote_object {
   my ($self, @args) = @_;
   Object::Remote::Handle->new(
     connection => $self, @args
   )->proxy;
 }
 
+sub connect {
+  my ($self, $to) = @_;
+  return await_future(
+    $self->send_class_call(0, 'Object::Remote', connect => $to)
+  );
+}
+
+sub remote_sub {
+  my ($self, $sub) = @_;
+  my ($pkg, $name) = $sub =~ m/^(.*)::([^:]+)$/;
+  return await_future($self->send_class_call(0, $pkg, can => $name));
+}
+
+sub send_class_call {
+  my ($self, $ctx, @call) = @_;
+  $self->send(call => class_call_handler => $ctx => call => @call);
+}
+
+sub register_class_call_handler {
+  my ($self) = @_;
+  $self->local_objects_by_id->{'class_call_handler'} ||= do {
+    my $o = $self->new_class_call_handler;
+    $self->_local_object_to_id($o);
+    $o;
+  };
+}
+
+sub new_class_call_handler {
+  Object::Remote::CodeContainer->new(
+    code => sub {
+      my ($class, $method) = (shift, shift);
+      use_module($class)->$method(@_);
+    }
+  );
+}
+
 sub register_remote {
   my ($self, $remote) = @_;
   weaken($self->remote_objects_by_id->{$remote->id} = $remote);
@@ -114,7 +157,6 @@ sub register_remote {
 
 sub await_ready {
   my ($self) = @_;
-  return if $self->is_ready;
   await_future($self->ready_future);
 }
 
@@ -127,11 +169,17 @@ sub send_free {
 sub send {
   my ($self, $type, @call) = @_;
 
-  unshift @call, $type => my $future = CPS::Future->new;
+  my $future = CPS::Future->new;
+  my $remote = $self->remote_objects_by_id->{$call[0]};
+
+  unshift @call, $type => $self->_local_object_to_id($future);
 
   my $outstanding = $self->outstanding_futures;
   $outstanding->{$future} = $future;
-  $future->on_ready(sub { delete $outstanding->{$future} });
+  $future->on_ready(sub {
+    undef($remote);
+    delete $outstanding->{$future}
+  });
 
   $self->_send(\@call);
 
@@ -141,7 +189,7 @@ sub send {
 sub send_discard {
   my ($self, $type, @call) = @_;
 
-  unshift @call, $type => { __remote_object__ => 'NULL' };
+  unshift @call, $type => 'NULL';
 
   $self->_send(\@call);
 }
@@ -149,14 +197,14 @@ sub send_discard {
 sub _send {
   my ($self, $to_send) = @_;
 
-  $self->await_ready unless $self->is_ready;
+  $self->await_ready;
 
   print { $self->send_to_fh } $self->_serialize($to_send)."\n";
 }
 
 sub _serialize {
   my ($self, $data) = @_;
-  local our @New_Ids;
+  local our @New_Ids = (-1);
   return eval {
     my $flat = $self->_encode($self->_deobjectify($data));
     warn "$$ >>> ${flat}\n" if $DEBUG;
@@ -173,7 +221,7 @@ sub _local_object_to_id {
   my ($self, $object) = @_;
   my $id = refaddr($object);
   $self->local_objects_by_id->{$id} ||= do {
-    push our(@New_Ids), $id;
+    push our(@New_Ids), $id if @New_Ids;
     $object;
   };
   return $id;
@@ -193,6 +241,8 @@ sub _deobjectify {
                  Object::Remote::CodeContainer->new(code => $data)
                );
       return +{ __remote_code__ => $id };
+    } elsif ($ref eq 'SCALAR') {
+      return +{ __scalar_ref__ => $$data };
     } else {
       die "Can't collapse reftype $ref";
     }
@@ -203,8 +253,10 @@ sub _deobjectify {
 sub _receive_data_from {
   my ($self, $fh) = @_;
   my $rb = $self->_receive_data_buffer;
-  my $ready = $self->is_ready;
-  if (sysread($fh, $$rb, 1024, length($$rb)) > 0) {
+  my $ready = $self->ready_future->is_ready;
+  my $len = sysread($fh, $$rb, 1024, length($$rb));
+  my $err = defined($len) ? '' : ": $!";
+  if (defined($len) and $len > 0) {
     while ($$rb =~ s/^(.*)\n//) {
       if ($ready) {
         $self->_receive($1);
@@ -212,7 +264,7 @@ sub _receive_data_from {
         my $line = $1;
         die "New remote container did not send Shere - got ${line}"
           unless $line eq "Shere";
-        $self->_set_is_ready($ready = 1);
+        $self->ready_future->done;
       }
     }
   } else {
@@ -222,7 +274,7 @@ sub _receive_data_from {
                       on_read_ready => 1
                     );
     my $outstanding = $self->outstanding_futures;
-    $_->fail("Connection lost") for values %$outstanding;
+    $_->fail("Connection lost${err}") for values %$outstanding;
     %$outstanding = ();
     $self->on_close->done();
   }
@@ -246,7 +298,8 @@ sub receive_free {
 }
 
 sub receive_call {
-  my ($self, $future, $id, @rest) = @_;
+  my ($self, $future_id, $id, @rest) = @_;
+  my $future = $self->_id_to_remote_object($future_id);
   $future->{method} = 'call_discard_free';
   my $local = $self->local_objects_by_id->{$id}
     or do { $future->fail("No such object $id"); return };
@@ -259,14 +312,6 @@ sub receive_call_free {
   $self->receive_free($id);
 }
 
-sub receive_class_call {
-  my ($self, $future, $class, @rest) = @_;
-  $future->{method} = 'call_discard_free';
-  eval { use_module($class) }
-    or do { $future->fail("Error loading ${class}: $@"); return };
-  $self->_invoke($future, $class, @rest);
-}
-
 sub _invoke {
   my ($self, $future, $local, $ctx, $method, @args) = @_;
   if ($method =~ /^start::/) {
@@ -299,3 +344,13 @@ sub DEMOLISH {
 }
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connection - An underlying connection for L<Object::Remote>
+
+=head1 LAME
+
+Shipping prioritised over writing this part up. Blame mst.
+
+=cut