net.razorvine.pyro

Class PyroProxy

java.lang.Object

net.razorvine.pyro.PyroProxy

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NameServerProxy

public class PyroProxy
extends Object
implements Serializable

Proxy for Pyro objects.

Author:

Irmen de Jong (irmen@razorvine.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	hostname
String	objectid
int	port
Set<String>	pyroAttrs
byte[]	pyroHmacKey
Set<String>	pyroMethods
Set<String>	pyroOneway

Constructor Summary

Constructors

Constructor and Description
PyroProxy() No-args constructor for (un)pickling support
PyroProxy(PyroURI uri) Create a proxy for the remote Pyro object denoted by the uri
PyroProxy(String hostname, int port, String objectid) Create a proxy for the remote Pyro object on the given host and port, with the given objectid/name.

Method Summary

Modifier and Type	Method and Description
void	__setstate__(Object[] args) called by the Unpickler to restore state args(6): pyroUri, pyroOneway(hashset), pyroMethods(set), pyroAttrs(set), pyroTimeout, pyroHmacKey
void	call_oneway(String method, Object... arguments) Call a method on the remote Pyro object this proxy is for, using Oneway call semantics (return immediately).
Object	call(String method, Object... arguments) Call a method on the remote Pyro object this proxy is for.
void	close() Close the network connection of this Proxy.
protected void	connect() (re)connect the proxy to the remote Pyro daemon.
void	finalize()
Object	getattr(String attr) Get the value of a remote attribute.
protected void	getMetadata(String objectId) get metadata from server (methods, attrs, oneway, ...) and remember them in some attributes of the proxy
protected void	handshake() Perform the Pyro protocol connection handshake with the Pyro daemon.
void	setattr(String attr, Object value) Set a new value on a remote attribute.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hostname

public String hostname

port

public int port

objectid

public String objectid

pyroHmacKey

public byte[] pyroHmacKey

pyroMethods

public Set<String> pyroMethods

pyroAttrs

public Set<String> pyroAttrs

pyroOneway

public Set<String> pyroOneway

Constructor Detail

PyroProxy

public PyroProxy()

No-args constructor for (un)pickling support

PyroProxy

public PyroProxy(PyroURI uri)
          throws UnknownHostException,
                 IOException

Create a proxy for the remote Pyro object denoted by the uri

Throws:

UnknownHostException

IOException

PyroProxy

public PyroProxy(String hostname,
                 int port,
                 String objectid)
          throws UnknownHostException,
                 IOException

Create a proxy for the remote Pyro object on the given host and port, with the given objectid/name.

Throws:

UnknownHostException

IOException

Method Detail

connect

protected void connect()
                throws UnknownHostException,
                       IOException

(re)connect the proxy to the remote Pyro daemon.

Throws:

UnknownHostException

IOException

getMetadata

protected void getMetadata(String objectId)
                    throws PickleException,
                           PyroException,
                           IOException

get metadata from server (methods, attrs, oneway, ...) and remember them in some attributes of the proxy

Throws:

PickleException

PyroException

IOException

call

public Object call(String method,
                   Object... arguments)
            throws PickleException,
                   PyroException,
                   IOException

Call a method on the remote Pyro object this proxy is for.

Parameters:

method - the name of the method you want to call

arguments - zero or more arguments for the remote method

Returns:

the result Object from the remote method call (can be anything, you need to typecast/introspect yourself).

Throws:

PickleException

PyroException

IOException

call_oneway

public void call_oneway(String method,
                        Object... arguments)
                 throws PickleException,
                        PyroException,
                        IOException

Call a method on the remote Pyro object this proxy is for, using Oneway call semantics (return immediately).

Parameters:

method - the name of the method you want to call

arguments - zero or more arguments for the remote method

Throws:

PickleException

PyroException

IOException

getattr

public Object getattr(String attr)
               throws PickleException,
                      PyroException,
                      IOException

Get the value of a remote attribute.

Parameters:

attr - the attribute name

Throws:

PickleException

PyroException

IOException

setattr

public void setattr(String attr,
                    Object value)
             throws PickleException,
                    PyroException,
                    IOException

Set a new value on a remote attribute.

Parameters:

attr - the attribute name

value - the new value for the attribute

Throws:

PickleException

PyroException

IOException

close

public void close()

Close the network connection of this Proxy. If you re-use the proxy, it will automatically reconnect.

finalize

public void finalize()

Overrides:

finalize in class Object

handshake

protected void handshake()
                  throws IOException

Perform the Pyro protocol connection handshake with the Pyro daemon.

Throws:

IOException

__setstate__

public void __setstate__(Object[] args)
                  throws IOException

called by the Unpickler to restore state args(6): pyroUri, pyroOneway(hashset), pyroMethods(set), pyroAttrs(set), pyroTimeout, pyroHmacKey

Throws:

IOException