RemoteServer

public class RemoteServer extends Server<RemoteMethod>

Objects of this class represent remote servers in a way that allows calling methods on them as if they were local.

Author

jmoringe, swrede, jwienke

Fields

DEFAULT_TIMEOUT

public static final double DEFAULT_TIMEOUT

Default timeout used to wait for method replies before throwing an exception [sec].

Constructors

RemoteServer

public RemoteServer(RemoteServerCreateArgs args)

Create a new RemoteServer object that provides its methods under the scope @a scope.

Parameters

args – The arguments to use for this new instance. The scope is the common super-scope under which the methods of the remote created server are provided.

Methods

addMethod

RemoteMethod addMethod(String name)

Creates a new method for this server with the specified name. Package private for unit testing. Do not use this externally otherwise.

Parameters

name – name of the method

Throws
Returns

the method instance for this new method

call

public Event call(String name, Event event)

Calls a method of the server using the method name and request data encapsulated in an Event instance. The method blocks until the server replied or until the timeout is reached.

Parameters

  • name – name of the method to call

  • event – request data

Throws
Returns

An event with the resulting data

call

public Event call(String name, Event event, double timeout)

Calls a method of the server using the method name and request data encapsulated in an Event instance. The method blocks until the server replied or until the specified timeout is reached.

Parameters

  • name – name of the method to call

  • event – request data

  • timeout – seconds to wait for the reply

Throws
Returns

An event with the resulting data

call

public Event call(String name)

Calls a method of the server without request parameter using the method name. The method blocks until the server replied or until the timeout is reached.

Parameters

name – name of the method to call

Throws
Returns

An event with the resulting data

call

public Event call(String name, double timeout)

Calls a method of the server without request parameter using the method name. The method blocks until the server replied or until the specified timeout is reached.

Parameters

  • name – name of the method to call

  • timeout – seconds to wait for the reply

Throws
Returns

An event with the resulting data

call

public <ReplyType, RequestType> ReplyType call(String name, RequestType data)

Calls a method of the server using the method name and plain request data. The method blocks until the server replied or until the timeout is reached.

Parameters

  • name – name of the method to call

  • data – request data

  • <ReplyType> – the data type expected for the reply data

  • <RequestType> – the data type of the passed in request data

Throws
Returns

An event with the resulting data

call

public <ReplyType, RequestType> ReplyType call(String name, RequestType data, double timeout)

Calls a method of the server using the method name and plain request data. The method blocks until the server replied or until the specified timeout is reached.

Parameters

  • name – name of the method to call

  • data – request data

  • timeout – seconds to wait for the reply

  • <ReplyType> – the data type expected for the reply data

  • <RequestType> – the data type of the passed in request data

Throws
Returns

An event with the resulting data

callAsync

public java.util.concurrent.Future<Event> callAsync(String name, Event event)

Calls a method of the server using the method name and request data encapsulated in an Event instance. The method returns immediately with a java.util.concurrent.Future instance.

Parameters

  • name – name of the method to call

  • event – request data

Throws

RSBException – communication errors or server-side errors

Returns

A java.util.concurrent.Future instance to retrieve the result Event

callAsync

public java.util.concurrent.Future<Event> callAsync(String name)

Calls a method of the server without request parameter using the method name. The method returns immediately with a java.util.concurrent.Future instance.

Parameters

name – name of the method to call

Throws

RSBException – communication errors or server-side errors

Returns

A java.util.concurrent.Future instance to retrieve the result Event

callAsync

public <ReplyType, RequestType> java.util.concurrent.Future<ReplyType> callAsync(String name, RequestType data)

Calls a method of the server using the method name and plain request data. The method returns immediately with a java.util.concurrent.Future instance.

Parameters

  • name – name of the method to call

  • data – the data to transfer as the method’s request parameter

  • <ReplyType> – the data type expected as the reply data

  • <RequestType> – the data type for the passed in request data

Throws

RSBException – communication errors or server-side errors

Returns

A java.util.concurrent.Future instance to retrieve the result data

getDataType

public Class<?> getDataType()

getKind

public String getKind()

getTimeout

public double getTimeout()

Returns the timeout used when waiting for replies from a server.

Returns

timeout in seconds