com.fnproject.fn.runtime.flow

Interface CompleterClient

All Known Implementing Classes:

RemoteFlowApiClient

public interface CompleterClient

Internal interface to a remote completion service

Method Summary

Modifier and Type	Method and Description
CompletionId	acceptEither(FlowId flowId, CompletionId completionId, CompletionId alternate, Serializable fn, CodeLocation codeLocation)
void	addTerminationHook(FlowId flowId, Serializable code, CodeLocation codeLocation)
CompletionId	allOf(FlowId flowId, List<CompletionId> cids, CodeLocation codeLocation)
CompletionId	anyOf(FlowId flowId, List<CompletionId> cids, CodeLocation codeLocation)
CompletionId	applyToEither(FlowId flowId, CompletionId completionId, CompletionId alternate, Serializable fn, CodeLocation codeLocation)
void	commit(FlowId flowId)
boolean	complete(FlowId flowId, CompletionId completionId, Object value, CodeLocation codeLocation)
CompletionId	completedValue(FlowId flowId, boolean success, Object value, CodeLocation codeLocation)
boolean	completeExceptionally(FlowId flowId, CompletionId completionId, Throwable value, CodeLocation codeLocation)
CompletionId	createCompletion(FlowId flowId, CodeLocation codeLocation)
FlowId	createFlow(String functionId) create a new flow against the flow service
CompletionId	delay(FlowId flowId, long l, CodeLocation codeLocation)
CompletionId	exceptionally(FlowId flowId, CompletionId completionId, Serializable fn, CodeLocation codeLocation)
CompletionId	exceptionallyCompose(FlowId flowId, CompletionId completionId, Serializable fn, CodeLocation codeLocation)
CompletionId	handle(FlowId flowId, CompletionId completionId, Serializable fn, CodeLocation codeLocation)
CompletionId	invokeFunction(FlowId flowId, String functionId, byte[] data, HttpMethod method, Headers headers, CodeLocation codeLocation)
CompletionId	supply(FlowId flowID, Serializable code, CodeLocation codeLocation)
CompletionId	thenAccept(FlowId flowId, CompletionId completionId, Serializable fn, CodeLocation codeLocation)
CompletionId	thenAcceptBoth(FlowId flowId, CompletionId completionId, CompletionId alternate, Serializable fn, CodeLocation codeLocation)
CompletionId	thenApply(FlowId flowID, CompletionId completionId, Serializable consumer, CodeLocation codeLocation)
CompletionId	thenCombine(FlowId flowId, CompletionId completionId, Serializable fn, CompletionId alternate, CodeLocation codeLocation)
CompletionId	thenCompose(FlowId flowId, CompletionId completionId, Serializable fn, CodeLocation codeLocation) Compose a function into the tree The transmitted function is wrapped to convert th ElvisFuture into it's completion iD
CompletionId	thenRun(FlowId flowId, CompletionId completionId, Serializable fn, CodeLocation codeLocation)
Object	waitForCompletion(FlowId flowId, CompletionId id, ClassLoader loader)
Object	waitForCompletion(FlowId flowId, CompletionId id, ClassLoader loader, long timeout, TimeUnit unit)
CompletionId	whenComplete(FlowId flowID, CompletionId completionId, Serializable consumer, CodeLocation codeLocation)

Method Detail

createFlow

FlowId createFlow(String functionId)

create a new flow against the flow service

Parameters:

functionId - Id of the function for which flow needs to be created

Returns:

a FlowId

supply

CompletionId supply(FlowId flowID,
                    Serializable code,
                    CodeLocation codeLocation)

thenApply

CompletionId thenApply(FlowId flowID,
                       CompletionId completionId,
                       Serializable consumer,
                       CodeLocation codeLocation)

whenComplete

CompletionId whenComplete(FlowId flowID,
                          CompletionId completionId,
                          Serializable consumer,
                          CodeLocation codeLocation)

thenCompose

CompletionId thenCompose(FlowId flowId,
                         CompletionId completionId,
                         Serializable fn,
                         CodeLocation codeLocation)

Compose a function into the tree The transmitted function is wrapped to convert th ElvisFuture into it's completion iD

Parameters:

flowId - flowId for thenCompose

completionId - completionId for thenCompose

fn - fn for thenCompose

codeLocation - codeLocation for thenCompose

Returns:

a completion ID that completes when the completion returned by the inner function completes

waitForCompletion

Object waitForCompletion(FlowId flowId,
                         CompletionId id,
                         ClassLoader loader)

waitForCompletion

Object waitForCompletion(FlowId flowId,
                         CompletionId id,
                         ClassLoader loader,
                         long timeout,
                         TimeUnit unit)
                  throws TimeoutException

Throws:

TimeoutException

thenAccept

CompletionId thenAccept(FlowId flowId,
                        CompletionId completionId,
                        Serializable fn,
                        CodeLocation codeLocation)

thenRun

CompletionId thenRun(FlowId flowId,
                     CompletionId completionId,
                     Serializable fn,
                     CodeLocation codeLocation)

acceptEither

CompletionId acceptEither(FlowId flowId,
                          CompletionId completionId,
                          CompletionId alternate,
                          Serializable fn,
                          CodeLocation codeLocation)

applyToEither

CompletionId applyToEither(FlowId flowId,
                           CompletionId completionId,
                           CompletionId alternate,
                           Serializable fn,
                           CodeLocation codeLocation)

complete

boolean complete(FlowId flowId,
                 CompletionId completionId,
                 Object value,
                 CodeLocation codeLocation)

completeExceptionally

boolean completeExceptionally(FlowId flowId,
                              CompletionId completionId,
                              Throwable value,
                              CodeLocation codeLocation)

anyOf

CompletionId anyOf(FlowId flowId,
                   List<CompletionId> cids,
                   CodeLocation codeLocation)

delay

CompletionId delay(FlowId flowId,
                   long l,
                   CodeLocation codeLocation)

thenAcceptBoth

CompletionId thenAcceptBoth(FlowId flowId,
                            CompletionId completionId,
                            CompletionId alternate,
                            Serializable fn,
                            CodeLocation codeLocation)

createCompletion

CompletionId createCompletion(FlowId flowId,
                              CodeLocation codeLocation)

invokeFunction

CompletionId invokeFunction(FlowId flowId,
                            String functionId,
                            byte[] data,
                            HttpMethod method,
                            Headers headers,
                            CodeLocation codeLocation)

completedValue

CompletionId completedValue(FlowId flowId,
                            boolean success,
                            Object value,
                            CodeLocation codeLocation)

allOf

CompletionId allOf(FlowId flowId,
                   List<CompletionId> cids,
                   CodeLocation codeLocation)

handle

CompletionId handle(FlowId flowId,
                    CompletionId completionId,
                    Serializable fn,
                    CodeLocation codeLocation)

exceptionally

CompletionId exceptionally(FlowId flowId,
                           CompletionId completionId,
                           Serializable fn,
                           CodeLocation codeLocation)

exceptionallyCompose

CompletionId exceptionallyCompose(FlowId flowId,
                                  CompletionId completionId,
                                  Serializable fn,
                                  CodeLocation codeLocation)

thenCombine

CompletionId thenCombine(FlowId flowId,
                         CompletionId completionId,
                         Serializable fn,
                         CompletionId alternate,
                         CodeLocation codeLocation)

commit

void commit(FlowId flowId)

addTerminationHook

void addTerminationHook(FlowId flowId,
                        Serializable code,
                        CodeLocation codeLocation)