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 is_ready => (is => 'rwp', trigger => sub {
39 my ($self, $value) = @_;
40 $self->ready_future->done if $value;
43 has ready_future => (is => 'lazy');
45 sub _build_ready_future { CPS::Future->new }
47 has _receive_data_buffer => (is => 'ro', default => sub { my $x = ''; \$x });
49 has local_objects_by_id => (is => 'ro', default => sub { {} });
51 has remote_objects_by_id => (is => 'ro', default => sub { {} });
53 has outstanding_futures => (is => 'ro', default => sub { {} });
58 _deserialize => 'decode',
63 sub _id_to_remote_object {
65 return bless({}, 'Object::Remote::Null') if $id eq 'NULL';
67 $self->remote_objects_by_id->{$id}
68 or Object::Remote::Handle->new(connection => $self, id => $id)
73 weaken(my $self = shift);
74 JSON::PP->new->filter_json_single_key_object(
75 __remote_object__ => sub {
76 $self->_id_to_remote_object(@_);
78 )->filter_json_single_key_object(
79 __remote_code__ => sub {
80 my $code_container = $self->_id_to_remote_object(@_);
81 sub { $code_container->call(@_) };
87 unshift our @Guess, sub { blessed($_[0]) ? $_[0] : undef };
88 eval { require Object::Remote::Connector::Local };
89 eval { require Object::Remote::Connector::LocalSudo };
90 eval { require Object::Remote::Connector::SSH };
94 my ($class, $spec) = @_;
95 foreach my $poss (do { our @Guess }) {
96 if (my $obj = $poss->($spec)) { return $obj }
98 die "Couldn't figure out what to do with ${spec}";
101 sub register_remote {
102 my ($self, $remote) = @_;
103 weaken($self->remote_objects_by_id->{$remote->id} = $remote);
109 return if $self->is_ready;
110 await_future($self->ready_future);
114 my ($self, $id) = @_;
115 delete $self->remote_objects_by_id->{$id};
116 $self->_send([ free => $id ]);
120 my ($self, $type, @call) = @_;
122 unshift @call, $type => my $future = CPS::Future->new;
124 my $outstanding = $self->outstanding_futures;
125 $outstanding->{$future} = $future;
126 $future->on_ready(sub { delete $outstanding->{$future} });
128 $self->_send(\@call);
134 my ($self, $type, @call) = @_;
136 unshift @call, $type => { __remote_object__ => 'NULL' };
138 $self->_send(\@call);
142 my ($self, $to_send) = @_;
144 $self->await_ready unless $self->is_ready;
146 print { $self->send_to_fh } $self->_serialize($to_send)."\n";
150 my ($self, $data) = @_;
153 my $flat = $self->_encode($self->_deobjectify($data));
154 warn "$$ >>> ${flat}\n" if $DEBUG;
157 my $err = $@; # won't get here if the eval doesn't die
158 # don't keep refs to new things
159 delete @{$self->local_objects_by_id}{@New_Ids};
160 die "Error serializing: $err";
164 sub _local_object_to_id {
165 my ($self, $object) = @_;
166 my $id = refaddr($object);
167 $self->local_objects_by_id->{$id} ||= do {
168 push our(@New_Ids), $id;
175 my ($self, $data) = @_;
176 if (blessed($data)) {
177 return +{ __remote_object__ => $self->_local_object_to_id($data) };
178 } elsif (my $ref = ref($data)) {
179 if ($ref eq 'HASH') {
180 return +{ map +($_ => $self->_deobjectify($data->{$_})), keys %$data };
181 } elsif ($ref eq 'ARRAY') {
182 return [ map $self->_deobjectify($_), @$data ];
183 } elsif ($ref eq 'CODE') {
184 my $id = $self->_local_object_to_id(
185 Object::Remote::CodeContainer->new(code => $data)
187 return +{ __remote_code__ => $id };
189 die "Can't collapse reftype $ref";
192 return $data; # plain scalar
195 sub _receive_data_from {
196 my ($self, $fh) = @_;
197 my $rb = $self->_receive_data_buffer;
198 my $ready = $self->is_ready;
199 if (sysread($fh, $$rb, 1024, length($$rb)) > 0) {
200 while ($$rb =~ s/^(.*)\n//) {
205 die "New remote container did not send Shere - got ${line}"
206 unless $line eq "Shere";
207 $self->_set_is_ready($ready = 1);
211 Object::Remote->current_loop
213 handle => $self->receive_from_fh,
216 my $outstanding = $self->outstanding_futures;
217 $_->fail("Connection lost") for values %$outstanding;
219 $self->on_close->done();
224 my ($self, $flat) = @_;
225 warn "$$ <<< $flat\n" if $DEBUG;
226 my ($type, @rest) = eval { @{$self->_deserialize($flat)} }
227 or do { warn "Deserialize failed for ${flat}: $@"; return };
228 eval { $self->${\"receive_${type}"}(@rest); 1 }
229 or do { warn "Receive failed for ${flat}: $@"; return };
234 my ($self, $id) = @_;
235 delete $self->local_objects_by_id->{$id}
236 or warn "Free: no such object $id";
241 my ($self, $future, $id, @rest) = @_;
242 $future->{method} = 'call_discard_free';
243 my $local = $self->local_objects_by_id->{$id}
244 or do { $future->fail("No such object $id"); return };
245 $self->_invoke($future, $local, @rest);
248 sub receive_call_free {
249 my ($self, $future, $id, @rest) = @_;
250 $self->receive_call($future, $id, undef, @rest);
251 $self->receive_free($id);
254 sub receive_class_call {
255 my ($self, $future, $class, @rest) = @_;
256 $future->{method} = 'call_discard_free';
257 eval { use_module($class) }
258 or do { $future->fail("Error loading ${class}: $@"); return };
259 $self->_invoke($future, $class, @rest);
263 my ($self, $future, $local, $ctx, $method, @args) = @_;
264 if ($method =~ /^start::/) {
265 my $f = $local->$method(@args);
266 $f->on_done(sub { undef($f); $future->done(@_) });
268 $f->on_fail(sub { undef($f); $future->fail(@_) });
271 my $do = sub { $local->$method(@args) };
275 ? ($ctx ? $do->() : scalar($do->()))
279 } or do { $future->fail($@); return; };
284 my ($self, $gd) = @_;
286 Object::Remote->current_loop
288 handle => $self->receive_from_fh,