GigaSpaces XAP 10.0.1 API

org.openspaces.events.notify
Annotation Type NotifyBatch


@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface NotifyBatch

Enables batching of notifications. Requires setting size() and time() which control when the batched notifications will be sent to the listener.

Author:
kimchy

Required Element Summary
 int size
          The batch size controls the number of notifications that will be sent in each batch.
 int time
          The batch time controls the elapsed time until the batch buffer is cleared and sent.
 
Optional Element Summary
 boolean passArrayAsIs
          When batching is turned on, should the batch of events be passed as an Object[] to the listener.
 int pendingThreshold
          The batch pending threshold controls the number of notifications that will be accumulated before they are sent.
 

Element Detail

size

public abstract int size
The batch size controls the number of notifications that will be sent in each batch.


time

public abstract int time
The batch time controls the elapsed time until the batch buffer is cleared and sent. The time is in milliseconds.

pendingThreshold

public abstract int pendingThreshold
The batch pending threshold controls the number of notifications that will be accumulated before they are sent. If not set, size parameter will be used.

Default:
-1

passArrayAsIs

public abstract boolean passArrayAsIs
When batching is turned on, should the batch of events be passed as an Object[] to the listener. Default to false which means it will be passed one event at a time.

Default:
false

GigaSpaces XAP 10.0.1 API

Copyright © GigaSpaces.