org.ballerinalang.util.program

Class BLangFunctions

java.lang.Object

org.ballerinalang.util.program.BLangFunctions

public class BLangFunctions
extends Object

This class contains helper methods to invoke Ballerina functions.

Since:

0.8.0

Method Summary

Modifier and Type	Method and Description
static BValue[]	invokeCallable(CallableUnitInfo callableUnitInfo, BValue[] args)
static void	invokeCallable(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx)
static BValue[]	invokeCallable(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx, BValue[] args)
static WorkerExecutionContext	invokeCallable(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx, int[] argRegs, int[] retRegs, boolean waitForResponse)
static WorkerExecutionContext	invokeCallable(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx, int[] argRegs, int[] retRegs, boolean waitForResponse, int flags)
static BValue[]	invokeEntrypointCallable(ProgramFile programFile, PackageInfo packageInfo, FunctionInfo functionInfo, BValue[] args)
static BValue[]	invokeEntrypointCallable(ProgramFile bLangProgram, String packageName, String callableName, BValue[] args) This method calls a program callable, considering it as an entry point callable.
static WorkerExecutionContext	invokeForkJoin(WorkerExecutionContext parentCtx, ForkjoinInfo forkjoinInfo, int joinTargetIp, int joinVarReg, int timeoutRegIndex, int timeoutTargetIp, int timeoutVarReg)
static WorkerExecutionContext	invokeNonNativeCallable(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx, int[] argRegs, int[] retRegs, boolean waitForResponse, int flags)
static void	invokeNonNativeCallableAsync(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx, int[] argRegs, int[] retRegs)
static void	invokePackageInitFunction(FunctionInfo initFuncInfo)
static void	invokePackageInitFunction(FunctionInfo initFuncInfo, WorkerExecutionContext context)
static void	invokeServiceCallable(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx, BValue[] args, CallableUnitCallback responseCallback)
static void	invokeServiceCallable(CallableUnitInfo callableUnitInfo, WorkerExecutionContext parentCtx, int[] argRegs, int[] retRegs, CallableUnitCallback responseCallback) This method does not short circuit the execution of the first worker to execute in the same calling thread, but rather executes all the workers in their own separate threads.
static void	invokeServiceInitFunction(FunctionInfo initFuncInfo)
static void	invokeVMUtilFunction(FunctionInfo initFuncInfo)
static void	invokeVMUtilFunction(FunctionInfo utilFuncInfo, WorkerExecutionContext context)

Methods inherited from class java.lang.Object

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

Method Detail

invokeEntrypointCallable

public static BValue[] invokeEntrypointCallable(ProgramFile bLangProgram,
                                                String packageName,
                                                String callableName,
                                                BValue[] args)

This method calls a program callable, considering it as an entry point callable. Which means, this callable will be invoked as the first callable in a program, and after it is called, all the cleanup will be done for it to exit from the program. That is, this callable will wait for the response to be fully available, and it will wait till all the workers in the system to finish executing.

Parameters:

bLangProgram - the program file

packageName - the package the callable is residing

callableName - the callable name

args - the callable arguments

Returns:

invokeEntrypointCallable

public static BValue[] invokeEntrypointCallable(ProgramFile programFile,
                                                PackageInfo packageInfo,
                                                FunctionInfo functionInfo,
                                                BValue[] args)

invokeCallable

public static void invokeCallable(CallableUnitInfo callableUnitInfo,
                                  WorkerExecutionContext parentCtx)

invokeCallable

public static BValue[] invokeCallable(CallableUnitInfo callableUnitInfo,
                                      BValue[] args)

invokeCallable

public static BValue[] invokeCallable(CallableUnitInfo callableUnitInfo,
                                      WorkerExecutionContext parentCtx,
                                      BValue[] args)

invokeServiceCallable

public static void invokeServiceCallable(CallableUnitInfo callableUnitInfo,
                                         WorkerExecutionContext parentCtx,
                                         BValue[] args,
                                         CallableUnitCallback responseCallback)

invokeServiceCallable

public static void invokeServiceCallable(CallableUnitInfo callableUnitInfo,
                                         WorkerExecutionContext parentCtx,
                                         int[] argRegs,
                                         int[] retRegs,
                                         CallableUnitCallback responseCallback)

This method does not short circuit the execution of the first worker to execute in the same calling thread, but rather executes all the workers in their own separate threads. This is specifically useful in executing service resources, where the calling transport threads shouldn't be blocked, but rather the worker threads should be used.

invokeCallable

public static WorkerExecutionContext invokeCallable(CallableUnitInfo callableUnitInfo,
                                                    WorkerExecutionContext parentCtx,
                                                    int[] argRegs,
                                                    int[] retRegs,
                                                    boolean waitForResponse)

invokeCallable

public static WorkerExecutionContext invokeCallable(CallableUnitInfo callableUnitInfo,
                                                    WorkerExecutionContext parentCtx,
                                                    int[] argRegs,
                                                    int[] retRegs,
                                                    boolean waitForResponse,
                                                    int flags)

invokeNonNativeCallable

public static WorkerExecutionContext invokeNonNativeCallable(CallableUnitInfo callableUnitInfo,
                                                             WorkerExecutionContext parentCtx,
                                                             int[] argRegs,
                                                             int[] retRegs,
                                                             boolean waitForResponse,
                                                             int flags)

invokeNonNativeCallableAsync

public static void invokeNonNativeCallableAsync(CallableUnitInfo callableUnitInfo,
                                                WorkerExecutionContext parentCtx,
                                                int[] argRegs,
                                                int[] retRegs)

invokePackageInitFunction

public static void invokePackageInitFunction(FunctionInfo initFuncInfo,
                                             WorkerExecutionContext context)

invokePackageInitFunction

public static void invokePackageInitFunction(FunctionInfo initFuncInfo)

invokeVMUtilFunction

public static void invokeVMUtilFunction(FunctionInfo utilFuncInfo,
                                        WorkerExecutionContext context)

invokeVMUtilFunction

public static void invokeVMUtilFunction(FunctionInfo initFuncInfo)

invokeServiceInitFunction

public static void invokeServiceInitFunction(FunctionInfo initFuncInfo)

invokeForkJoin

public static WorkerExecutionContext invokeForkJoin(WorkerExecutionContext parentCtx,
                                                    ForkjoinInfo forkjoinInfo,
                                                    int joinTargetIp,
                                                    int joinVarReg,
                                                    int timeoutRegIndex,
                                                    int timeoutTargetIp,
                                                    int timeoutVarReg)