org.ballerinalang.bre.bvm

Class AsyncInvocableWorkerResponseContext

java.lang.Object

org.ballerinalang.bre.bvm.BaseWorkerResponseContext

org.ballerinalang.bre.bvm.CallableWorkerResponseContext

org.ballerinalang.bre.bvm.SyncCallableWorkerResponseContext

org.ballerinalang.bre.bvm.AsyncInvocableWorkerResponseContext

All Implemented Interfaces:

WorkerResponseContext

public class AsyncInvocableWorkerResponseContext
extends SyncCallableWorkerResponseContext

This class represents a WorkerResponseContext implementation which supports calling the asynchronous functions.

Field Summary

Fields inherited from class org.ballerinalang.bre.bvm.CallableWorkerResponseContext

fulfilled, haltCount, responseTypes, workerErrors

Fields inherited from class org.ballerinalang.bre.bvm.BaseWorkerResponseContext

currentSignal, responseCallbacks, retRegIndexes, targetCtx, workerCount, workerDataChannels

Constructor Summary

Constructors

Constructor and Description
AsyncInvocableWorkerResponseContext(CallableUnitInfo callableUnitInfo)
AsyncInvocableWorkerResponseContext(CallableUnitInfo callableUnitInfo, int workerCount)

Method Summary

Modifier and Type	Method and Description
boolean	cancel()
boolean	isCancelled()
boolean	isDone()
WorkerExecutionContext	joinTargetContextInfo(WorkerExecutionContext targetCtx, int[] retRegIndexes) Joins a new target worker execution context to the current response context.
WorkerExecutionContext	onFulfillment(boolean runInCaller)
protected WorkerExecutionContext	propagateErrorToTarget()
void	setWorkerExecutionContexts(List<WorkerExecutionContext> workerExecutionContexts)
WorkerExecutionContext	signal(WorkerSignal signal) This is called by the workers to signal the response context of any signal that needs to be passed into.

Methods inherited from class org.ballerinalang.bre.bvm.SyncCallableWorkerResponseContext

onError, onHalt, onMessage, onReturn

Methods inherited from class org.ballerinalang.bre.bvm.CallableWorkerResponseContext

getCurrentSignal, getWorkerErrors, handleAlreadyFulfilled, initWorkerErrors, isFulfilled, isReturnable, isWorkersDone, onFinalizedError, printError, printStoredErrors, setAsFulfilled, setCurrentSignal, storeError

Methods inherited from class org.ballerinalang.bre.bvm.BaseWorkerResponseContext

doFailCallbackNotify, doSuccessCallbackNotify, getWorkerDataChannel, modifyDebugCommands, onTimeout, registerResponseCallback

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsyncInvocableWorkerResponseContext

public AsyncInvocableWorkerResponseContext(CallableUnitInfo callableUnitInfo,
                                           int workerCount)

AsyncInvocableWorkerResponseContext

public AsyncInvocableWorkerResponseContext(CallableUnitInfo callableUnitInfo)

Method Detail

setWorkerExecutionContexts

public void setWorkerExecutionContexts(List<WorkerExecutionContext> workerExecutionContexts)

signal

public WorkerExecutionContext signal(WorkerSignal signal)

Description copied from interface: WorkerResponseContext

This is called by the workers to signal the response context of any signal that needs to be passed into. For example, a worker returning, or reporting an error upstream.

Specified by:

signal in interface WorkerResponseContext

Overrides:

signal in class BaseWorkerResponseContext

Parameters:

signal - the signal to be passed in

Returns:

the worker execution context, if not null, that should be executed after returning from this call, this is used to re-use the same calling thread to execute the following worker execution

joinTargetContextInfo

public WorkerExecutionContext joinTargetContextInfo(WorkerExecutionContext targetCtx,
                                                    int[] retRegIndexes)

Description copied from interface: WorkerResponseContext

Joins a new target worker execution context to the current response context. This will add a new interested party to the current response, which will be notified immediately if the response is already fulfilled, by returning a worker execution context to execute, which would be the calling context itself if there's no error (or else, after the error is resolved, the final executable worker execution context), or else, it will return null, and the caller should be notified later, by resuming the worker execution context later, when the response is fulfilled.

Specified by:

joinTargetContextInfo in interface WorkerResponseContext

Overrides:

joinTargetContextInfo in class BaseWorkerResponseContext

Parameters:

targetCtx - the target worker execution context

retRegIndexes - the return registry locations of the target execution context where the current worker execution context should report to

Returns:

the worker execution context that should be executed after the join

onFulfillment

public WorkerExecutionContext onFulfillment(boolean runInCaller)

Overrides:

onFulfillment in class CallableWorkerResponseContext

propagateErrorToTarget

protected WorkerExecutionContext propagateErrorToTarget()

Overrides:

propagateErrorToTarget in class CallableWorkerResponseContext

isDone

public boolean isDone()

isCancelled

public boolean isCancelled()

cancel

public boolean cancel()