com.pcloud.networking.client

Interface MultiCall

All Superinterfaces:

java.lang.Cloneable

public interface MultiCall
extends java.lang.Cloneable

A contract for an object which can handle multiple calls

A MultiCall object can execute several calls one after another. MultiCall objects can and should be reused via the clone() method.

Note that all Request objects to add to a MultiCall should be opted for the same Endpoint

See Also:

MultiCallback, Call, Response, MultiResponse, Request

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels all the calls within this MultiCall
MultiCall	clone() Clones this MultiCall object into a new instance with all the same parameters in order for it to be reused.
void	enqueue(MultiCallback callback) Executes the call on another thread and does not block the calling thread
MultiResponse	enqueueAndWait() Executes the calls on another thread but blocks the calling thread until the operation is complete or an exception is thrown.
MultiResponse	enqueueAndWait(long timeout, java.util.concurrent.TimeUnit timeUnit) Executes the calls on another thread but blocks the calling thread for at most the duration specified in the arguments.
MultiResponse	execute() Executes the calls on the same thread and blocks it until the operation is complete or an exception is thrown.
boolean	isCancelled() Returns true if this MultiCall has been cancelled, false otherwise
boolean	isExecuted() Returns true if the all the calls have been executed already, false otherwise
java.util.List<Request>	requests() Returns a List of the Request objects in this MultiCall
Interactor	start() Start executing the call and return a Interactor

Method Detail

requests

java.util.List<Request> requests()

Returns a List of the Request objects in this MultiCall

Returns:

A List of the Request objects for this MultiCall

execute

MultiResponse execute()
               throws java.io.IOException

Executes the calls on the same thread and blocks it until the operation is complete or an exception is thrown.

Returns:

A reference to the MultiResponse of this call

Throws:

java.io.IOException - On failed IO operations

start

Interactor start()

Start executing the call and return a Interactor

For more details on usage, see Interactor

Returns:

a new Interactor instance

enqueueAndWait

MultiResponse enqueueAndWait()
                      throws java.io.IOException,
                             java.lang.InterruptedException

Executes the calls on another thread but blocks the calling thread until the operation is complete or an exception is thrown.

Returns:

A reference to the MultiResponse of this call

Throws:

java.io.IOException - On failed IO operations

java.lang.InterruptedException - On interruption of the waiting thread

enqueueAndWait

MultiResponse enqueueAndWait(long timeout,
                             java.util.concurrent.TimeUnit timeUnit)
                      throws java.io.IOException,
                             java.lang.InterruptedException,
                             java.util.concurrent.TimeoutException

Executes the calls on another thread but blocks the calling thread for at most the duration specified in the arguments.

Note that it is not guaranteed that all the calls will execute in time and you are not guaranteed to receive a MultiResponse within the time you specified.

Parameters:

timeout - The maximum amount of waiting time before an attempt to collect and return a MultiResponse

timeUnit - The TimeUnit in which you have specified the waiting time

Returns:

A reference to the MultiResponse of this call

Throws:

java.io.IOException - On failed IO operations

java.lang.InterruptedException - On interruption of the waiting thread

java.util.concurrent.TimeoutException - If all the calls have not been executed prior to the maximum time specified running out

enqueue

void enqueue(MultiCallback callback)

Executes the call on another thread and does not block the calling thread

Parameters:

callback - A MultiCallback to be fired upon a successful execution of a call, upon an exception being thrown or upon completion of all the calls

isExecuted

boolean isExecuted()

Returns true if the all the calls have been executed already, false otherwise

Returns:

true if all the calls have been executed already, false otherwise

cancel

void cancel()

Cancels all the calls within this MultiCall

Note that once cancelled a MultiCall can not be executed properly again unless it is cloned first.

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 clone()

Clones this MultiCall object into a new instance with all the same parameters in order for it to be reused.

Returns:

A reference to a new instance of a MultiCall object with the same parameters as this one.