Engine

Description

Functions to get information about the Engine.

Categories

NameDescription
LocaleFunctions to get info about the locale.
ProfilerFunctions to profile the engine.
RtcFunctions directly related to the RTC.
VariableFunctions to set and get Engine Variable.

Functions

NameSignature and Synopsis
assertEvent_Asyncvoid assertEvent_Async()
Asserts a simple event using WorkManager
clusterSubscriptionLoadOnlyvoid clusterSubscriptionLoadOnly()
Loads the Entity that comes from Cluster Subscription into the working memory only and does not execute any rule for it.This can only be used in the preprocessor for the Entity which Subscribes Cluster.
engineNameString engineName ()
Returns the name of the TIBCO BusinessEvents engine.
executeRulesvoid executeRules()
Execute Rules in the preprocessor context.
executeRulesAsyncvoid executeRulesAsync(String workManagerID)
Execute Rules in the preprocessor context. Execution is done in parallel mode using the supplied work-manager
executionContextString[] executionContext()
Return the current execution context. The first element in the String[] indicates where this call is executing under. The remaining elements in the String[] contains the objects that associated with the context. For example, if this is executing in Rule A.B.C and the scope is InstanceX. This function will returns { $1Rule=A.B.C$1, $1InstanceX@id=12@extId=123$1 }.
gcvoid gc()
Runs the Java Garbage Collection.
invokeRuleObject[] invokeRule(String uri, Object[] inputSet, boolean dirtyRead)
Find all the matched tuples of a rule given partial input set. And for each matched tuple, execute the rule action.
invokeRuleFunctionObject invokeRuleFunction(String uri, Object[] arguments)
Invoke a rule function by name.
jvmMemoryFreelong jvmMemoryFree ()
Returns an estimate of the free memory available to the JVM.
jvmMemoryMaxlong jvmMemoryMax ()
Returns the maximum memory size of the JVM.
jvmMemoryUsedlong jvmMemoryUsed ()
Returns an estimate of the used memory in the JVM.
loadResourceAsByteObject loadResourceAsByte(String uri)
When a relative path to a file is provided, then the byte representation of the file contents are returned.
loadResourceAsStringString loadResourceAsString(String uri, String encoding)
When a relative path to a file is provided, then the contents of the file are returned in String format. The type of encoding to be used can be determined by the user. In case no encoding is provided, then UTF-8 is used by default.
numberOfEventsint numberOfEvents()
Returns the total number of events exist in the working memory
numberOfInstancesint numberOfInstances()
Returns the total number of instances exist in the working memory
numberOfRulesFiredlong numberOfRulesFired ()
Returns the total number of rules fired in the current working memory since the counter was last reset.
resetNumberOfRulesFiredvoid resetNumberOfRulesFired ()
Resets the counter that tracks the total number of rules fired in the current working memory.
ruleFunctionNameString ruleFunctionName()
Return the name of the currently executing RuleFunction, or "" if there is none.
sessionIndexString sessionName ()
Returns the current Index of the RuleSession in the EAR's. If numLocal is provided, then it will give that info.
sessionNameString sessionName ()
Returns the current RuleSession Name.
shutdownvoid shutdown(boolean immediate)
Shuts down the BusinessEvents engine.
sleepvoid sleep(long millisec)
Put current rule session to sleep. Caution! In case of single-threaded RTC, this method may block current thread as well as all other rule sessions.
threadNameString threadName()
Gets the name of the current thread.