Events

grails.events.Events

Bridges the OLD API to the new
deprecated:
Here for compatibility only. Do not use directly

Properties Summary

Properties
Type	Name and description
`EventBus`	`eventBus`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`clearEventConsumers(java.lang.Object key)` Clears event consumers for the given key
`<T>`	`grails.events.Event<T>`	`eventFor(T data)` Creates an grails.events.Event for the given data
`<T>`	`grails.events.Event<T>`	`eventFor(java.util.Map<java.lang.String, java.lang.Object> headers, T data)` Creates an grails.events.Event for the given headers and data
`<T>`	`grails.events.Event<T>`	`eventFor(java.util.Map<java.lang.String, java.lang.Object> headers, T data, groovy.lang.Closure<java.lang.Throwable> errorConsumer)` Creates an grails.events.Event for the given headers, data and error consumer
	`Bus`	`notify(java.lang.Object key, grails.events.Event<?> ev)` @see reactor.bus.Bus#notify(java.lang.Object, java.lang.Object)
	`Bus`	`notify(java.lang.Object key, java.lang.Object data)` @see reactor.bus.Bus#notify(java.lang.Object, reactor.bus.Event)
`<E extends Event<?>>`	`Bus`	`notify(java.lang.Object key, groovy.lang.Closure<E> supplier)`
`<E extends Event<?>>`	`Registration<java.lang.Object, Consumer<E>>`	`on(java.lang.Class key, groovy.lang.Closure consumer)` @see #on(reactor.bus.selector.Selector, reactor.fn.Consumer)
`<E extends Event<?>>`	`Registration<java.lang.Object, Consumer<E>>`	`on(Selector key, groovy.lang.Closure consumer)` @see #on(reactor.bus.selector.Selector, reactor.fn.Consumer)
`<E extends Event<?>>`	`Registration<java.lang.Object, Consumer<E>>`	`on(java.lang.Object key, groovy.lang.Closure consumer)` @see #on(reactor.bus.selector.Selector, reactor.fn.Consumer)
`<E extends Event<?>>`	`Registration<java.lang.Object, Consumer<E>>`	`on(java.lang.Object key, Consumer<E> consumer)` @see #on(reactor.bus.selector.Selector, reactor.fn.Consumer)
`<E extends Event<?>>`	`Registration<java.lang.Object, Consumer<E>>`	`on(java.lang.Class type, Consumer<E> consumer)` @see #on(reactor.bus.selector.Selector, reactor.fn.Consumer)
`<E extends Event<?>>`	`Registration<java.lang.Object, Consumer<E>>`	`on(Selector sel, Consumer<E> consumer)` Register a Consumer to be triggered when a notification matches the given Selector.
	`Bus`	`sendAndReceive(java.lang.Object key, java.lang.Object data, groovy.lang.Closure reply)`
`<E extends Event<?>>`	`Bus`	`sendAndReceive(java.lang.Object key, groovy.lang.Closure reply)`

- Property Detail
  - EventBus eventBus
- Method Detail
  - boolean clearEventConsumers(java.lang.Object key)
    
    Clears event consumers for the given key
    Parameters:
    key - The key
    Returns:
    True if modifications were made
  - <T> grails.events.Event<T> eventFor(T data)
    
    Creates an grails.events.Event for the given data
    Parameters:
    data - The data
    Returns:
    The event
  - <T> grails.events.Event<T> eventFor(java.util.Map<java.lang.String, java.lang.Object> headers, T data)
    
    Creates an grails.events.Event for the given headers and data
    Parameters:
    headers - The headers
    data - The data
    Returns:
    The event
  - <T> grails.events.Event<T> eventFor(java.util.Map<java.lang.String, java.lang.Object> headers, T data, groovy.lang.Closure<java.lang.Throwable> errorConsumer)
    
    Creates an grails.events.Event for the given headers, data and error consumer
    Parameters:
    headers - The headers
    data - The data
    errorConsumer - The errors consumer
    Returns:
    The event
  - Bus notify(java.lang.Object key, grails.events.Event<?> ev)
    
    See Also:
    Bus.notify
  - Bus notify(java.lang.Object key, java.lang.Object data)
    
    See Also:
    Bus.notify
  - <E extends Event<?>> Bus notify(java.lang.Object key, groovy.lang.Closure<E> supplier)
  - <E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Class key, groovy.lang.Closure consumer)
    
    See Also:
    on(reactor.bus.selector.Selector, reactor.fn.Consumer)
  - <E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(Selector key, groovy.lang.Closure consumer)
    
    See Also:
    on(reactor.bus.selector.Selector, reactor.fn.Consumer)
  - <E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Object key, groovy.lang.Closure consumer)
    
    See Also:
    on(reactor.bus.selector.Selector, reactor.fn.Consumer)
  - <E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Object key, Consumer<E> consumer)
    
    See Also:
    on(reactor.bus.selector.Selector, reactor.fn.Consumer)
  - <E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Class type, Consumer<E> consumer)
    
    See Also:
    on(reactor.bus.selector.Selector, reactor.fn.Consumer)
  - <E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(Selector sel, Consumer<E> consumer)
    
    Register a Consumer to be triggered when a notification matches the given Selector.
    Parameters:
    sel - The Selector to be used for matching
    consumer - The Consumer to be triggered
    - The type of the grails.events.Event
    Returns:
    A Subscription object that allows the caller to interact with the given mapping
  - Bus sendAndReceive(java.lang.Object key, java.lang.Object data, groovy.lang.Closure reply)
  - <E extends Event<?>> Bus sendAndReceive(java.lang.Object key, groovy.lang.Closure reply)

Summary:
Property
Method

| Detail:
Property
Method

[Groovy] Trait Events

Properties Summary

Methods Summary

Property Detail

EventBus eventBus

Method Detail

boolean clearEventConsumers(java.lang.Object key)

<T> grails.events.Event<T> eventFor(T data)

<T> grails.events.Event<T> eventFor(java.util.Map<java.lang.String, java.lang.Object> headers, T data)

<T> grails.events.Event<T> eventFor(java.util.Map<java.lang.String, java.lang.Object> headers, T data, groovy.lang.Closure<java.lang.Throwable> errorConsumer)

Bus notify(java.lang.Object key, grails.events.Event<?> ev)

Bus notify(java.lang.Object key, java.lang.Object data)

<E extends Event<?>> Bus notify(java.lang.Object key, groovy.lang.Closure<E> supplier)

<E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Class key, groovy.lang.Closure consumer)

<E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(Selector key, groovy.lang.Closure consumer)

<E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Object key, groovy.lang.Closure consumer)

<E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Object key, Consumer<E> consumer)

<E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(java.lang.Class type, Consumer<E> consumer)

<E extends Event<?>> Registration<java.lang.Object, Consumer<E>> on(Selector sel, Consumer<E> consumer)

Bus sendAndReceive(java.lang.Object key, java.lang.Object data, groovy.lang.Closure reply)

<E extends Event<?>> Bus sendAndReceive(java.lang.Object key, groovy.lang.Closure reply)