1 package Object::Remote::Connection;
3 use Object::Remote::Future;
4 use Object::Remote::Null;
5 use Object::Remote::Handle;
6 use Object::Remote::CodeContainer;
9 use Module::Runtime qw(use_module);
10 use Scalar::Util qw(weaken blessed refaddr);
11 use JSON::PP qw(encode_json);
14 our $DEBUG = !!$ENV{OBJECT_REMOTE_DEBUG};
17 is => 'ro', required => 1,
18 trigger => sub { $_[1]->autoflush(1) },
21 has receive_from_fh => (
22 is => 'ro', required => 1,
26 Object::Remote->current_loop
29 on_read_ready => sub { $self->_receive_data_from($fh) }
34 has on_close => (is => 'rw', default => sub { CPS::Future->new });
36 has child_pid => (is => 'ro');
38 has ready_future => (is => 'lazy');
40 sub _build_ready_future { CPS::Future->new }
42 has _receive_data_buffer => (is => 'ro', default => sub { my $x = ''; \$x });
44 has local_objects_by_id => (is => 'ro', default => sub { {} });
46 has remote_objects_by_id => (is => 'ro', default => sub { {} });
48 has outstanding_futures => (is => 'ro', default => sub { {} });
53 _deserialize => 'decode',
58 sub _id_to_remote_object {
60 return bless({}, 'Object::Remote::Null') if $id eq 'NULL';
62 $self->remote_objects_by_id->{$id}
63 or Object::Remote::Handle->new(connection => $self, id => $id)
68 weaken(my $self = shift);
69 JSON::PP->new->filter_json_single_key_object(
70 __remote_object__ => sub {
71 $self->_id_to_remote_object(@_);
73 )->filter_json_single_key_object(
74 __remote_code__ => sub {
75 my $code_container = $self->_id_to_remote_object(@_);
76 sub { $code_container->call(@_) };
82 unshift our @Guess, sub { blessed($_[0]) ? $_[0] : undef };
83 eval { require Object::Remote::Connector::Local };
84 eval { require Object::Remote::Connector::LocalSudo };
85 eval { require Object::Remote::Connector::SSH };
86 eval { require Object::Remote::Connector::UNIX };
90 my ($class, $spec) = @_;
91 return $spec if blessed $spec;
92 foreach my $poss (do { our @Guess }) {
93 if (my $obj = $poss->($spec)) { return $obj }
95 die "Couldn't figure out what to do with ${spec}";
99 my ($self, @args) = @_;
100 Object::Remote::Handle->new(
101 connection => $self, @args
106 my ($self, $to) = @_;
107 return await_future($self->send(
108 class_call => 'Object::Remote', 0, connect => $to
113 my ($self, $sub) = @_;
114 my ($pkg, $name) = $sub =~ m/^(.*)::([^:]+)$/;
115 return await_future($self->send(class_call => $pkg, 0, can => $name));
118 sub register_remote {
119 my ($self, $remote) = @_;
120 weaken($self->remote_objects_by_id->{$remote->id} = $remote);
126 await_future($self->ready_future);
130 my ($self, $id) = @_;
131 delete $self->remote_objects_by_id->{$id};
132 $self->_send([ free => $id ]);
136 my ($self, $type, @call) = @_;
138 unshift @call, $type => my $future = CPS::Future->new;
140 my $outstanding = $self->outstanding_futures;
141 $outstanding->{$future} = $future;
142 $future->on_ready(sub { delete $outstanding->{$future} });
144 $self->_send(\@call);
150 my ($self, $type, @call) = @_;
152 unshift @call, $type => { __remote_object__ => 'NULL' };
154 $self->_send(\@call);
158 my ($self, $to_send) = @_;
162 print { $self->send_to_fh } $self->_serialize($to_send)."\n";
166 my ($self, $data) = @_;
169 my $flat = $self->_encode($self->_deobjectify($data));
170 warn "$$ >>> ${flat}\n" if $DEBUG;
173 my $err = $@; # won't get here if the eval doesn't die
174 # don't keep refs to new things
175 delete @{$self->local_objects_by_id}{@New_Ids};
176 die "Error serializing: $err";
180 sub _local_object_to_id {
181 my ($self, $object) = @_;
182 my $id = refaddr($object);
183 $self->local_objects_by_id->{$id} ||= do {
184 push our(@New_Ids), $id;
191 my ($self, $data) = @_;
192 if (blessed($data)) {
193 return +{ __remote_object__ => $self->_local_object_to_id($data) };
194 } elsif (my $ref = ref($data)) {
195 if ($ref eq 'HASH') {
196 return +{ map +($_ => $self->_deobjectify($data->{$_})), keys %$data };
197 } elsif ($ref eq 'ARRAY') {
198 return [ map $self->_deobjectify($_), @$data ];
199 } elsif ($ref eq 'CODE') {
200 my $id = $self->_local_object_to_id(
201 Object::Remote::CodeContainer->new(code => $data)
203 return +{ __remote_code__ => $id };
205 die "Can't collapse reftype $ref";
208 return $data; # plain scalar
211 sub _receive_data_from {
212 my ($self, $fh) = @_;
213 my $rb = $self->_receive_data_buffer;
214 my $ready = $self->ready_future->is_ready;
215 my $len = sysread($fh, $$rb, 1024, length($$rb));
216 my $err = defined($len) ? undef : ": $!";
217 if (defined($len) and $len > 0) {
218 while ($$rb =~ s/^(.*)\n//) {
223 die "New remote container did not send Shere - got ${line}"
224 unless $line eq "Shere";
225 $self->ready_future->done;
229 Object::Remote->current_loop
231 handle => $self->receive_from_fh,
234 my $outstanding = $self->outstanding_futures;
235 $_->fail("Connection lost${err}") for values %$outstanding;
237 $self->on_close->done();
242 my ($self, $flat) = @_;
243 warn "$$ <<< $flat\n" if $DEBUG;
244 my ($type, @rest) = eval { @{$self->_deserialize($flat)} }
245 or do { warn "Deserialize failed for ${flat}: $@"; return };
246 eval { $self->${\"receive_${type}"}(@rest); 1 }
247 or do { warn "Receive failed for ${flat}: $@"; return };
252 my ($self, $id) = @_;
253 delete $self->local_objects_by_id->{$id}
254 or warn "Free: no such object $id";
259 my ($self, $future, $id, @rest) = @_;
260 $future->{method} = 'call_discard_free';
261 my $local = $self->local_objects_by_id->{$id}
262 or do { $future->fail("No such object $id"); return };
263 $self->_invoke($future, $local, @rest);
266 sub receive_call_free {
267 my ($self, $future, $id, @rest) = @_;
268 $self->receive_call($future, $id, undef, @rest);
269 $self->receive_free($id);
272 sub receive_class_call {
273 my ($self, $future, $class, @rest) = @_;
274 $future->{method} = 'call_discard_free';
275 eval { use_module($class) }
276 or do { $future->fail("Error loading ${class}: $@"); return };
277 $self->_invoke($future, $class, @rest);
281 my ($self, $future, $local, $ctx, $method, @args) = @_;
282 if ($method =~ /^start::/) {
283 my $f = $local->$method(@args);
284 $f->on_done(sub { undef($f); $future->done(@_) });
286 $f->on_fail(sub { undef($f); $future->fail(@_) });
289 my $do = sub { $local->$method(@args) };
293 ? ($ctx ? $do->() : scalar($do->()))
297 } or do { $future->fail($@); return; };
302 my ($self, $gd) = @_;
304 Object::Remote->current_loop
306 handle => $self->receive_from_fh,