com.pcloud.networking.api

Interface MultiCall<T,R>

Type Parameters:

T - The requests for this MultiCall

R - The results for this MultiCall

All Superinterfaces:

java.lang.Cloneable

public interface MultiCall<T,R>
extends java.lang.Cloneable

A contract for an object able to execute many calls to a server and return the results

The request can be executed in a number of ways

• execute() will synchronously execute all the calls one by one on the same thread blocking until its done or an exception is thrown
• enqueue(MultiCallback) will asynchronously enqueue on another thread calling a MultiCallback to report progress, success or failure
• enqueueAndWait() will enqueue on another thread but will block the calling thread until its done or an exception is thrown
• Can be used only once. You can check if this call has been executed via isExecuted()
• To reuse you can call clone() and execute the clone object
• It is safe to call cancel() multiple times

See Also:

MultiCallback

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels all the requests in this MultiCall
MultiCall<T,R>	clone() Creates a new instance of a MultiCall object to be reused for the same calls
void	enqueue(MultiCallback<T,R> callback) Enqueues asynchronously and calls a MultiCallback to notify progress, completion or failure
java.util.List<R>	enqueueAndWait() Enqueues on another thread but blocks the calling thread until completion or until an exception is thrown
java.util.List<R>	enqueueAndWait(long timeout, java.util.concurrent.TimeUnit timeUnit) Enqueues on another thread but blocks the calling thread for at most the amount of time specified in the arguments.
java.util.List<R>	execute() Executes synchronously and blocks until completion or until an exception is thrown
boolean	isCancelled() Returns true if this MultiCall has been cancelled, false otherwise
boolean	isExecuted() Returns true if this MultiCall has been executed already
java.lang.String	methodName() The API method name to be executed.
java.util.List<T>	requests() Returns a List of the requests for this MultiCall
Interactor<R>	start() Start executing the call and return a Interactor

Method Detail

methodName

java.lang.String methodName()

The API method name to be executed.

Returns:

the non-null method name

requests

java.util.List<T> requests()

Returns a List of the requests for this MultiCall

Returns:

A List of the requests for this MultiCall

execute

java.util.List<R> execute()
                   throws java.io.IOException

Executes synchronously and blocks until completion or until an exception is thrown

Returns:

A List of the result objects

Throws:

java.io.IOException - on failed IO operations

enqueueAndWait

java.util.List<R> enqueueAndWait()
                          throws java.io.IOException,
                                 java.lang.InterruptedException

Enqueues on another thread but blocks the calling thread until completion or until an exception is thrown

Returns:

A List of the results from the requests

Throws:

java.io.IOException - on failed network operations

java.lang.InterruptedException - if the calling thread is interrupted

enqueueAndWait

java.util.List<R> enqueueAndWait(long timeout,
                                 java.util.concurrent.TimeUnit timeUnit)
                          throws java.io.IOException,
                                 java.lang.InterruptedException,
                                 java.util.concurrent.TimeoutException

Enqueues on another thread but blocks the calling thread for at most the amount of time specified in the arguments.

Note you are not guaranteed to receive all the responses in the time you specified and if all the operations are not complete in this time a TimeoutException will be thrown

Parameters:

timeout - The maximum amount of time before an attempt to collect the results from this operation

timeUnit - The unit in which you specified the time argument

Returns:

A List containing the results from the network calls

Throws:

java.io.IOException - on failed IO operations

java.lang.InterruptedException - if the waiting thread was interrupted

java.util.concurrent.TimeoutException - if the time is up before all the responses have been received

enqueue

void enqueue(MultiCallback<T,R> callback)

Enqueues asynchronously and calls a MultiCallback to notify progress, completion or failure

Parameters:

callback - The MultiCallback to be fired on success or failure

start

Interactor<R> start()

Start executing the call and return a Interactor

For more details on usage, see Interactor

Returns:

a new Interactor instance

isExecuted

boolean isExecuted()

Returns true if this MultiCall has been executed already

Returns:

true if this MultiCall has been executed already

cancel

void cancel()

Cancels all the requests in this MultiCall

isCancelled

boolean isCancelled()

Returns true if this MultiCall has been cancelled, false otherwise

Returns:

true if this MultiCall has been cancelled, false otherwise

clone

MultiCall<T,R> clone()

Creates a new instance of a MultiCall object to be reused for the same calls

Returns:

A cloned new instance of a MultiCall to make new requests