org.openspaces.events.asyncpolling

Annotation Type AsyncPolling

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Component
public @interface AsyncPolling

Marks an event listener an asyncronous polled event listener. It will be wrapped automtically with SimpleAsyncPollingEventListenerContainer.

Template can be provided using EventTemplate marked on a general method that returns the template.

The event listener method should be marked with SpaceDataEvent.

Author:

kimchy

See Also:

TransactionalEvent, AsyncHandler

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoStart Set whether this container will start once instantiated.
int	concurrentConsumers Specify the number of concurrent consumers to create.
String	gigaSpace The name of the bean that is the GigaSpace this container will use.
boolean	performSnapshot If set to true will perform snapshot operation on the provided template before invoking registering as an event listener.
long	receiveTimeout Set the timeout to use for receive calls, in milliseconds.
String	value The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an autodetected component.

Element Detail

value

public abstract String value

The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an autodetected component.

Returns:

the suggested component name, if any

Default:

""

gigaSpace

public abstract String gigaSpace

The name of the bean that is the GigaSpace this container will use.

Note, this is optional. If there is only one GigaSpace defined in the application context, it will be used.

Default:

""

concurrentConsumers

public abstract int concurrentConsumers

Specify the number of concurrent consumers to create. Default is 1.

See Also:

SimpleAsyncPollingEventListenerContainer.setConcurrentConsumers(int)

Default:

1

receiveTimeout

public abstract long receiveTimeout

Set the timeout to use for receive calls, in milliseconds. The default is 60000 ms, that is, 1 minute.

NOTE: This value needs to be smaller than the transaction timeout used by the transaction manager (in the appropriate unit, of course).

See Also:

SimplePollingEventListenerContainer.setReceiveTimeout(long)

Default:

60000L

performSnapshot

public abstract boolean performSnapshot

If set to true will perform snapshot operation on the provided template before invoking registering as an event listener.

See Also:

GigaSpace.snapshot(Object), AbstractEventListenerContainer.setPerformSnapshot(boolean)

Default:

true

autoStart

public abstract boolean autoStart

Set whether this container will start once instantiated.

Default is true. Set to false in order for this container to be started using AbstractEventListenerContainer.start().

Default:

true