Package ortus.boxlang.runtime.bifs.global.system

Class BoxAnnounce

java.lang.Object

ortus.boxlang.runtime.bifs.BIF

ortus.boxlang.runtime.bifs.global.system.BoxAnnounce

Direct Known Subclasses:

BoxAnnounceAsync

@BoxBIF(description="Announce an event synchronously")
public class BoxAnnounce
extends BIF

Field Summary

Fields inherited from class ortus.boxlang.runtime.bifs.BIF

__functionName, __isMemberExecution, asyncService, cacheService, componentService, declaredArguments, functionService, interceptorService, logger, moduleService, runtime, schedulerService

Constructor Summary

Constructors

Constructor	Description
BoxAnnounce()	Constructor

Method Summary

Modifier and Type	Method	Description
Object	_invoke(IBoxContext context, ArgumentsScope arguments)	Announce a BoxLang event to a specific interceptor pool.
protected InterceptorPool	getTargetPool(String poolName, IBoxContext context)	Get the target interceptor pool based on the pool name.

Methods inherited from class ortus.boxlang.runtime.bifs.BIF

announce, getDeclaredArguments, invoke

Methods inherited from class java.lang.Object

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

Constructor Details

BoxAnnounce

public BoxAnnounce()

Constructor

Method Details

_invoke

public Object _invoke(IBoxContext context,
 ArgumentsScope arguments)

Announce a BoxLang event to a specific interceptor pool. By default, the event is announced to the global interception service. Available pools are "global" and "request". The request pool is tied to the application listener and is only available during the request lifecycle. Example:

 // Announce globally
 boxAnnounce( "onRequestStart", { request = request } )

 // Announce to the application request
 boxAnnounce( "myRequestEvent", { data : myData }, "request" )
 

Specified by:

_invoke in class BIF

Parameters:

context - The context in which the BIF is being invoked.

arguments - Argument scope for the BIF.

Returns:

The result of the invocation

getTargetPool

protected InterceptorPool getTargetPool(String poolName,
 IBoxContext context)

Get the target interceptor pool based on the pool name.

Parameters:

poolName - The name of the pool to get.

context - The context in which the BIF is being invoked.

Returns:

The target interceptor pool.