com.esotericsoftware.kryonet.rmi

Interface RemoteObject

public interface RemoteObject

Provides access to various settings on a remote object.

Author:

Nathan Sweet

See Also:

ObjectSpace.getRemoteObject(com.esotericsoftware.kryonet.Connection, int, Class...)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Causes this RemoteObject to stop listening to the connection for method invocation response messages.
Connection	getConnection() Returns the local connection for this remote object.
byte	getLastResponseID() Gets the ID of response for the last method invocation.
void	setNonBlocking(boolean nonBlocking) Sets the blocking behavior when invoking a remote method.
void	setRemoteToString(boolean remoteToString) If false, calls to Object.toString() will return "" instead of being invoking the remote method.
void	setResponseTimeout(int timeoutMillis) Sets the milliseconds to wait for a method to return value.
void	setTransmitExceptions(boolean transmit) Sets whether exceptions are sent back when invoking a remote method.
void	setTransmitReturnValue(boolean transmit) Sets whether return values are sent back when invoking a remote method.
Object	waitForLastResponse() Waits for the response to the last method invocation to be received or the response timeout to be reached.
Object	waitForResponse(byte responseID) Waits for the specified method invocation response to be received or the response timeout to be reached.

Method Detail

setResponseTimeout

void setResponseTimeout(int timeoutMillis)

Sets the milliseconds to wait for a method to return value. Default is 3000.

setNonBlocking

void setNonBlocking(boolean nonBlocking)

Sets the blocking behavior when invoking a remote method. Default is false.

Parameters:

nonBlocking - If false, the invoking thread will wait for the remote method to return or timeout (default). If true, the invoking thread will not wait for a response. The method will return immediately and the return value should be ignored. If they are being transmitted, the return value or any thrown exception can later be retrieved with waitForLastResponse() or waitForResponse(byte). The responses will be stored until retrieved, so each method call should have a matching retrieve.

setTransmitReturnValue

void setTransmitReturnValue(boolean transmit)

Sets whether return values are sent back when invoking a remote method. Default is true.

Parameters:

transmit - If true, then the return value for non-blocking method invocations can be retrieved with waitForLastResponse() or waitForResponse(byte). If false, then non-primitive return values for remote method invocations are not sent by the remote side of the connection and the response can never be retrieved. This can also be used to save bandwidth if you will not check the return value of a blocking remote invocation. Note that an exception could still be returned by waitForLastResponse() or waitForResponse(byte) if setTransmitExceptions(boolean) is true.

setTransmitExceptions

void setTransmitExceptions(boolean transmit)

Sets whether exceptions are sent back when invoking a remote method. Default is true.

Parameters:

transmit - If false, exceptions will be unhandled and rethrown as RuntimeExceptions inside the invoking thread. This is the legacy behavior. If true, behavior is dependent on whether setNonBlocking(boolean). If non-blocking is true, the exception will be serialized and sent back to the call site of the remotely invoked method, where it will be re-thrown. If non-blocking is false, an exception will not be thrown in the calling thread but instead can be retrieved with waitForLastResponse() or waitForResponse(byte), similar to a return value.

setRemoteToString

void setRemoteToString(boolean remoteToString)

If false, calls to Object.toString() will return "" instead of being invoking the remote method. Default is false.

waitForLastResponse

Object waitForLastResponse()

Waits for the response to the last method invocation to be received or the response timeout to be reached. Must not be called from the connection's update thread.

See Also:

ObjectSpace.getRemoteObject(com.esotericsoftware.kryonet.Connection, int, Class...)

getLastResponseID

byte getLastResponseID()

Gets the ID of response for the last method invocation.

waitForResponse

Object waitForResponse(byte responseID)

Waits for the specified method invocation response to be received or the response timeout to be reached. Must not be called from the connection's update thread. Response IDs use a six bit identifier, with one identifier reserved for "no response". This means that this method should be called to get the result for a non-blocking call before an additional 63 non-blocking calls are made, or risk undefined behavior due to identical IDs.

See Also:

ObjectSpace.getRemoteObject(com.esotericsoftware.kryonet.Connection, int, Class...)

close

void close()

Causes this RemoteObject to stop listening to the connection for method invocation response messages.

getConnection

Connection getConnection()

Returns the local connection for this remote object.