org.ballerinalang.bre.bvm

Class BaseWorkerResponseContext

java.lang.Object

org.ballerinalang.bre.bvm.BaseWorkerResponseContext

All Implemented Interfaces:

WorkerResponseContext

Direct Known Subclasses:

CallableWorkerResponseContext

public abstract class BaseWorkerResponseContext
extends Object
implements WorkerResponseContext

This class represents the base implementation for a WorkerResponseContext.

Field Summary

Fields

Modifier and Type	Field and Description
protected WorkerSignal	currentSignal
protected List<CallableUnitCallback>	responseCallbacks
protected int[]	retRegIndexes
protected WorkerExecutionContext	targetCtx
protected int	workerCount
protected Map<String,WorkerDataChannel>	workerDataChannels

Constructor Summary

Constructors

Constructor and Description
BaseWorkerResponseContext(int workerCount)

Method Summary

Modifier and Type	Method and Description
protected void	doFailCallbackNotify(BStruct error)
protected void	doSuccessCallbackNotify()
WorkerDataChannel	getWorkerDataChannel(String name) Creates and returns the data channels used to communicate between the workers.
WorkerExecutionContext	joinTargetContextInfo(WorkerExecutionContext targetCtx, int[] retRegIndexes) Joins a new target worker execution context to the current response context.
protected void	modifyDebugCommands(WorkerExecutionContext parent, WorkerExecutionContext child)
protected WorkerExecutionContext	onError(WorkerSignal signal)
protected WorkerExecutionContext	onHalt(WorkerSignal signal)
protected void	onMessage(WorkerSignal signal)
protected WorkerExecutionContext	onReturn(WorkerSignal signal)
protected WorkerExecutionContext	onTimeout(WorkerSignal signal)
void	registerResponseCallback(CallableUnitCallback responseCallback) Registers a response callback handler with this context.
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 java.lang.Object

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

Field Detail

retRegIndexes

protected int[] retRegIndexes

currentSignal

protected WorkerSignal currentSignal

responseCallbacks

protected List<CallableUnitCallback> responseCallbacks

targetCtx

protected WorkerExecutionContext targetCtx

workerDataChannels

protected Map<String,WorkerDataChannel> workerDataChannels

workerCount

protected int workerCount

Constructor Detail

BaseWorkerResponseContext

public BaseWorkerResponseContext(int workerCount)

Method Detail

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

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

onTimeout

protected WorkerExecutionContext onTimeout(WorkerSignal signal)

onMessage

protected void onMessage(WorkerSignal signal)

onHalt

protected WorkerExecutionContext onHalt(WorkerSignal signal)

onError

protected WorkerExecutionContext onError(WorkerSignal signal)

onReturn

protected WorkerExecutionContext onReturn(WorkerSignal signal)

modifyDebugCommands

protected void modifyDebugCommands(WorkerExecutionContext parent,
                                   WorkerExecutionContext child)

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

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

getWorkerDataChannel

public WorkerDataChannel getWorkerDataChannel(String name)

Description copied from interface: WorkerResponseContext

Creates and returns the data channels used to communicate between the workers.

Specified by:

getWorkerDataChannel in interface WorkerResponseContext

Parameters:

name - the unique name of the data channel name requested

Returns:

the data channel

registerResponseCallback

public void registerResponseCallback(CallableUnitCallback responseCallback)

Registers a response callback handler with this context. This must be registered before any actions are done on the response context, or else, the events will not be triggered on the callback.

Parameters:

responseCallback - the response callback

doSuccessCallbackNotify

protected void doSuccessCallbackNotify()

doFailCallbackNotify

protected void doFailCallbackNotify(BStruct error)