com.pcloud.networking.client

Interface Call

All Superinterfaces:

java.lang.Cloneable

public interface Call
extends java.lang.Cloneable

A contract for a network call to a server

See Also:

Request, Response

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels this Call.
Call	clone() Clones the current Call into a new instance with the same parameters and returns it.
void	enqueue(Callback callback) Enqueues the Call on another thread.
Response	enqueueAndWait() Enqueues the call on another thread and blocks the calling thread until the Response is received or an exception is thrown.
Response	enqueueAndWait(long timeout, java.util.concurrent.TimeUnit timeUnit) Enqueues the call on another thread and blocks the calling thread for at most the given time period after which provides the Response if ready.
Response	execute() Executes the call.
boolean	isCancelled() Returns a boolean to show if the Call has been cancelled already.
boolean	isExecuted() Returns a boolean to show if the Call has been executed already.
Request	request() Provides the Request of this call

Method Detail

request

Request request()

Provides the Request of this call

Returns:

The Request of this call

execute

Response execute()
          throws java.io.IOException

Executes the call.

Note this method executes on the thread on which it's called an blocks until it's done or an exception is thrown.

Returns:

The Response of the call

Throws:

java.io.IOException - on failed IO operations

enqueueAndWait

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

Enqueues the call on another thread and blocks the calling thread until the Response is received or an exception is thrown.

Returns:

The Response of the call

Throws:

java.io.IOException - on failed IO operations

java.lang.InterruptedException - if the thread is interrupted during execution

enqueueAndWait

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

Enqueues the call on another thread and blocks the calling thread for at most the given time period after which provides the Response if ready.

Note that you are not guaranteed to receive the expected Response within the time period specified.

Parameters:

timeout - The maximum period of time after which the Call should try to retrieve the result

timeUnit - The unit in which you've provided the time period

Returns:

The Response if the computation is completed within the time period specified

Throws:

java.io.IOException - on failed IO operations

java.lang.InterruptedException - on interruption of the computation

java.util.concurrent.TimeoutException - if the Response was not received within the time period

enqueue

void enqueue(Callback callback)

Enqueues the Call on another thread.

Callback.onResponse(Call, Response) will be called if all goes well Callback.onFailure(Call, IOException) will be called in case there was an exception during the call

Parameters:

callback - The Callback to be fired upon completion or an error.

isExecuted

boolean isExecuted()

Returns a boolean to show if the Call has been executed already.

Note that a Call can only be executed once

Returns:

true if the Call has been executed already, false otherwise

cancel

void cancel()

Cancels this Call.

Note that once cancelled a Call will not be executable properly after that.

isCancelled

boolean isCancelled()

Returns a boolean to show if the Call has been cancelled already.

Returns:

true if the Call has been cancelled, false otherwise

clone

Call clone()

Clones the current Call into a new instance with the same parameters and returns it.

Returns:

A new instance of a Call with the same parameters