1 package Object::Remote;
3 use Object::Remote::MiniLoop;
4 use Object::Remote::Handle;
5 use Object::Remote::Logging qw( :log );
6 use Module::Runtime qw(use_module);
8 our $VERSION = '0.002003'; # 0.2.3
11 Object::Remote::Logging->init_logging;
15 my ($class, $on, @args) = @_;
16 my $conn = __PACKAGE__->connect($on);
17 log_trace { sprintf("constructing instance of $class on connection for child pid of %i", $conn->child_pid) };
18 return $conn->remote_object(class => $class, args => \@args);
22 my ($class, $on, $name) = @_;
23 my $conn = __PACKAGE__->connect($on);
24 log_trace { "Invoking remote \$class->can('$name')" };
25 return $conn->remote_sub(join('::', $class, $name));
30 Object::Remote::Handle->new(@_)->proxy;
34 my ($class, $to) = @_;
35 use_module('Object::Remote::Connection')->maybe::start::new_from_spec($to);
39 our $Current_Loop ||= Object::Remote::MiniLoop->new
46 Object::Remote - Call methods on objects in other processes or on other hosts
50 Creating a connection:
54 my $conn = Object::Remote->connect('myserver'); # invokes ssh
58 my $capture = IPC::System::Simple->can::on($conn, 'capture');
60 warn $capture->('uptime');
64 my $eval = Eval::WithLexicals->new::on($conn);
66 $eval->eval(q{my $x = `uptime`});
68 warn $eval->eval(q{$x});
70 Importantly: 'myserver' only requires perl 5.8+ - no non-core modules need to
71 be installed on the far side, Object::Remote takes care of it for you!
75 Object::Remote allows you to create an object in another process - usually
76 one running on another machine you can connect to via ssh, although there
77 are other connection mechanisms available.
79 The idea here is that in many cases one wants to be able to run a piece of
80 code on another machine, or perhaps many other machines - but without having
81 to install anything on the far side.
87 The "main" API, which provides the L</connect> method to create a connection
88 to a remote process/host, L</new::on> to create an object on a connection,
89 and L</can::on> to retrieve a subref over a connection.
91 =head2 Object::Remote::Connection
93 The object representing a connection, which provides the
94 L<Object::Remote::Connection/remote_object> and
95 L<Object::Remote::Connection/remote_sub> methods that are used by
96 L</new::on> and L</can::on> to return proxies for objects and subroutines
99 =head2 Object::Remote::Future
101 Code for dealing with asynchronous operations, which provides the
102 L<Object::Remote::Future/start::method> syntax for calling a possibly
103 asynchronous method without blocking, and
104 L<Object::Remote::Future/await_future> and L<Object::Remote::Future/await_all>
105 to block until an asynchronous call completes or fails.
111 my $conn = Object::Remote->connect('-'); # fork()ed connection
113 my $conn = Object::Remote->connect('myserver'); # connection over ssh
115 my $conn = Object::Remote->connect('user@myserver'); # connection over ssh
117 my $conn = Object::Remote->connect('root@'); # connection over sudo
121 my $eval = Eval::WithLexicals->new::on($conn);
123 my $eval = Eval::WithLexicals->new::on('myserver'); # implicit connect
125 my $obj = Some::Class->new::on($conn, %args); # with constructor arguments
129 my $hostname = Sys::Hostname->can::on($conn, 'hostname');
131 my $hostname = Sys::Hostname->can::on('myserver', 'hostname');
135 IRC: #web-simple on irc.perl.org
139 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
143 phaylon - Robert Sedlacek (cpan:PHAYLON) <r.sedlacek@shadowcat.co.uk>
147 Parts of this code were paid for by
149 Socialflow L<http://www.socialflow.com>
151 Shadowcat Systems L<http://www.shadow.cat>
155 Copyright (c) 2012 the Object::Remote L</AUTHOR>, L</CONTRIBUTORS> and
156 L</SPONSORS> as listed above.
160 This library is free software and may be distributed under the same terms