com.amazon.carbonado.capability

Interface RemoteProcedure.Call<R,D>

Type Parameters:

R - reply object type

D - request data object type

Enclosing interface:

RemoteProcedure<R,D>

public static interface RemoteProcedure.Call<R,D>

Client-side call into a remote procedure. To avoid leaking resources, the finish method must be invoked or all reply data be fully read. If an exception is thrown by a method defined in this interface, resources are automatically released.

See Also:

RemoteProcedureCapability.beginCall(com.amazon.carbonado.capability.RemoteProcedure<R, D>)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Executes the call without expecting a reply.
void	executeAsync() Executes the call without expecting a reply.
Cursor<R>	fetchReply() Executes the call and receive a reply.
void	flush() Flushes all the data sent so far.
RemoteProcedure.Call<R,D>	reset() Reset the internal object stream of the call, allowing cached objects to get freed.
RemoteProcedure.Call<R,D>	send(D data) Send data to the remote procedure.
RemoteProcedure.Call<R,D>	sendAll(Cursor<? extends D> cursor) Send all data from the given cursor to the remote procedure.
RemoteProcedure.Call<R,D>	sendAll(java.lang.Iterable<? extends D> iterable) Send all data from the given iterable to the remote procedure.

Method Detail

send

RemoteProcedure.Call<R,D> send(D data)
                               throws RepositoryException

Send data to the remote procedure.

Returns:

this Call instance

Throws:

java.lang.IllegalArgumentException - if data is null

java.lang.IllegalStateException - if a call has been executed

RepositoryException

sendAll

RemoteProcedure.Call<R,D> sendAll(java.lang.Iterable<? extends D> iterable)
                                  throws RepositoryException

Send all data from the given iterable to the remote procedure.

Returns:

this Call instance

Throws:

java.lang.IllegalArgumentException - if data is null

java.lang.IllegalStateException - if a call has been executed

RepositoryException

sendAll

RemoteProcedure.Call<R,D> sendAll(Cursor<? extends D> cursor)
                                  throws RepositoryException

Send all data from the given cursor to the remote procedure.

Returns:

this Call instance

Throws:

java.lang.IllegalArgumentException - if data is null

java.lang.IllegalStateException - if a call has been executed

RepositoryException

reset

RemoteProcedure.Call<R,D> reset()
                                throws RepositoryException

Reset the internal object stream of the call, allowing cached objects to get freed.

Returns:

this Call instance

Throws:

java.lang.IllegalStateException - if a call has been executed

RepositoryException

flush

void flush()
           throws RepositoryException

Flushes all the data sent so far. Flush is invoked automatically when call is executed.

Throws:

RepositoryException

fetchReply

Cursor<R> fetchReply()
                     throws RepositoryException

Executes the call and receive a reply. Calling this method does not block, but methods on the returned Cursor may block waiting for data.

Throws:

java.lang.IllegalStateException - if a call has been executed

RepositoryException

execute

void execute()
             throws RepositoryException

Executes the call without expecting a reply. Method blocks waiting for procedure to finish.

Throws:

java.lang.IllegalStateException - if a call has been executed

RepositoryException

executeAsync

void executeAsync()
                  throws RepositoryException

Executes the call without expecting a reply. Method does not block waiting for procedure to finish. Asynchronous execution is not allowed if the current thread is in a transaction. This is because transaction ownership becomes ambiguous.

Throws:

java.lang.IllegalStateException - if a call has been executed or if current thread is in a transaction

RepositoryException