com.pcloud.networking.api

Interface Interactor<T>

Type Parameters:

T - The response type

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

public interface Interactor<T>
extends java.io.Closeable

A Iterator-like interface allowing the execution of MultiCalls in a pull-based fashion.

Using this class when executing MultiCall instances gives more control over connection writes and reads, providing the following benefits:

• The number of simultaneous request writes can be controlled.
• Responses can be read in an iterative fashion, avoiding the need for buffering.
• Reading can start before all requests have been written.
• The execution can be stopped in the middle of the process, with decisions on each received response.

NOTE:Take care of calling close() when done with objects of this type, or resource leaks will occur.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	hasMoreRequests()
boolean	hasNextResponse()
T	nextResponse() Read the next response
int	submitRequests(int count) Write a given amount of requests.

Method Detail

hasMoreRequests

boolean hasMoreRequests()

Returns:

true if there are more requests that can be written, false otherwise.

submitRequests

int submitRequests(int count)
            throws java.io.IOException

Write a given amount of requests.

When called, the method will block and attempt to send at most count requests, but no more than the remaining request count left to be sent. The returned value is the actual number of requests sent.

For an example, if the total request count is 5, submitRequests(6) will return 5. Next calls to submitRequests() will always return 0.

Parameters:

count - the amount of requests to be sent

Returns:

the actual number of sent requests

Throws:

java.lang.IllegalArgumentException - when count < 0

java.io.IOException - if an error occurs during sending, or the MultiCall has been cancelled.

hasNextResponse

boolean hasNextResponse()

Returns:

true if there are more Ts that can be read, false otherwise.

nextResponse

T nextResponse()
        throws java.io.IOException

Read the next response

When called, the method will block and attempt to read a single response, either returning the result or failing with an error.

The method will throw an IllegalStateException if the number of sent requests is equal to the number of received responses to avoid the case where the method will be waiting for a response, but none is expected to arrive, thus blocking forever (or a connection read timeout is reached).

Returns:

the next T

Throws:

java.lang.IllegalStateException - if trying to read more responses than sent requests

java.io.IOException - if an error occurs during reading, or the MultiCall has been cancelled.

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable