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

Class BoxAnnounceAsync

java.lang.Object

ortus.boxlang.runtime.bifs.BIF

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

ortus.boxlang.runtime.bifs.global.system.BoxAnnounceAsync

@BoxBIF(description="Announce an event asynchronously")
public class BoxAnnounceAsync
extends BoxAnnounce

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
BoxAnnounceAsync()	Constructor

Method Summary

Modifier and Type	Method	Description
Object	_invoke(IBoxContext context, ArgumentsScope arguments)	Announce a BoxLang event to the global system interceptor service asynchronously.

Methods inherited from class ortus.boxlang.runtime.bifs.global.system.BoxAnnounce

getTargetPool

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

BoxAnnounceAsync

public BoxAnnounceAsync()

Constructor

Method Details

_invoke

public Object _invoke(IBoxContext context,
 ArgumentsScope arguments)

Announce a BoxLang event to the global system interceptor service asynchronously. By default, the event is announced to the global interception service. The return value is a BoxLang CompletableFuture that will be completed when the event has been announced. 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
 var future = announceAsync( "onRequestStart", { request = request } )

 // Announce to the application request
 var future = announceAsync( "myRequestEvent", { data : myData }, "request" )
 

Overrides:

_invoke in class BoxAnnounce

Parameters:

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

arguments - Argument scope for the BIF.

Returns:

A CompletableFuture that will be completed when the event has been announced, or null if the state doesn't exist