net.sergeych.farcall

Class Farcall

java.lang.Object

net.sergeych.farcall.Farcall

public class Farcall
extends java.lang.Object

The Farcall protocol general implementation.

Cross-platform fast, simple and elegant RPC protocol. Supports function calls with typed arguments (any that Connector supports), as arrays, keywords or both, return values and remote exceptions.

Protocol description can be found here: https://github.com/sergeych/farcall/wiki along with the corresponding ruby gem.

Created by sergeych on 10.04.16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Farcall.CommandResult Deferred result of the Farcall command execution, to be used inside the farcall package.
static class	Farcall.RemoteException The exception information that was passed from the remote party, while executing some command.
static interface	Farcall.Target

Constructor Summary

Constructors

Constructor and Description
Farcall(Connector connector) Create Farcall connected to some endpoint.

Method Summary

Modifier and Type	Method and Description
void	asyncCommands() Allow farcall to use own ExecutorSerice to run commands in parallel.
void	asyncCommands(java.util.concurrent.ExecutorService service) Let farcall execute remote comands in the executor service.
void	close()
boolean	isClosed()
Farcall.CommandResult	send(java.lang.String name) Send command without parameters
Farcall.CommandResult	send(java.lang.String name, java.util.ArrayList<java.lang.Object> params, java.util.HashMap<java.lang.String,java.lang.Object> keyParams) Send remote command with all kind of parameters
Farcall.CommandResult	sendKeyParams(java.lang.String name, java.lang.Object... keysAndValues) Send remote command with only keyed parameters.
Farcall.CommandResult	sendParams(java.lang.String name, java.lang.Object... params) Send Farcall command to the remote with only array parameters.
void	start() Start the protocol in one-way mode: this instance only issues commands.
void	start(Farcall.Target target) Start a worker thread that reads connector data, and executes recevied commamds using specified interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

Farcall

public Farcall(Connector connector)

Create Farcall connected to some endpoint. To start actual working call start() or start(Target).

Parameters:

connector -

Method Detail

asyncCommands

public void asyncCommands(java.util.concurrent.ExecutorService service)

Let farcall execute remote comands in the executor service. It means that Farcall.Target.onCommand(Command) will be executed using this service (what means, most often, asynchronouly.

Parameters:

service - to use. Call with null to resore synchronous operations.

asyncCommands

public void asyncCommands()

Allow farcall to use own ExecutorSerice to run commands in parallel. It means that Farcall.Target.onCommand(Command) will be executed using this service asynchronouly.

start

public void start(Farcall.Target target)

Start a worker thread that reads connector data, and executes recevied commamds using specified interface.

Parameters:

target - callback to process incoming commands

start

public void start()

Start the protocol in one-way mode: this instance only issues commands. Any commands from remote will return error 'unknown_command'

isClosed

public boolean isClosed()

send

public Farcall.CommandResult send(java.lang.String name)

Send command without parameters

Parameters:

name - of the command

Returns:

deferred result

send

public Farcall.CommandResult send(java.lang.String name,
                                  java.util.ArrayList<java.lang.Object> params,
                                  java.util.HashMap<java.lang.String,java.lang.Object> keyParams)

Send remote command with all kind of parameters

Parameters:

name - of the command

params - array parameters or null

keyParams - map parameters or null

Returns:

deferred result

sendParams

public Farcall.CommandResult sendParams(java.lang.String name,
                                        java.lang.Object... params)

Send Farcall command to the remote with only array parameters. To read remote answer, use returned DeferredResult instance.

Parameters:

name - command name

params - array parameters

Returns:

deferred result

sendKeyParams

public Farcall.CommandResult sendKeyParams(java.lang.String name,
                                           java.lang.Object... keysAndValues)

Send remote command with only keyed parameters. The arguments shoul be sequence of key, value pairs, where keys must be String. For example:

     farcall.sendKeyParams("foo", "param1", 10, "param2", 20, "bar", "baz")
 

The return value being passed via DeferredResult is either data returned by the remote party, e.g. List, Map, simple types, strings, or whatever else Connector allows, or, in the case the remote throws and error, instance of the Farcall.RemoteException class.

Parameters:

name -

keysAndValues - key1, value1, key2, value2... sequence

Returns:

deferred result

close

public void close()