org.onosproject.event

Class AbstractEventAccumulator

java.lang.Object

org.onosproject.event.AbstractEventAccumulator

All Implemented Interfaces:

EventAccumulator

public abstract class AbstractEventAccumulator
extends Object
implements EventAccumulator

Base implementation of an event accumulator. It allows triggering based on event inter-arrival time threshold, maximum batch life threshold and maximum batch size.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEventAccumulator(Timer timer, int maxEvents, int maxBatchMillis, int maxIdleMillis) Creates an event accumulator capable of triggering on the specified thresholds.

Method Summary

Modifier and Type	Method and Description
void	add(Event event) Adds an event to the current batch.
int	maxBatchMillis() Returns the maximum number of millis allowed to expire since the first event before processing is triggered.
int	maxEvents() Returns the maximum number of events allowed to accumulate before processing is triggered.
int	maxIdleMillis() Returns the maximum number of millis allowed to expire since the last event arrival before processing is triggered.
Timer	timer() Returns the backing timer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.event.EventAccumulator

processEvents

Constructor Detail

AbstractEventAccumulator

protected AbstractEventAccumulator(Timer timer,
                                   int maxEvents,
                                   int maxBatchMillis,
                                   int maxIdleMillis)

Creates an event accumulator capable of triggering on the specified thresholds.

Parameters:

timer - timer to use for scheduling check-points

maxEvents - maximum number of events to accumulate before processing is triggered

maxBatchMillis - maximum number of millis allowed since the first event before processing is triggered

maxIdleMillis - maximum number millis between events before processing is triggered

Method Detail

add

public void add(Event event)

Description copied from interface: EventAccumulator

Adds an event to the current batch. This operation may, or may not trigger processing of the current batch of events.

Specified by:

add in interface EventAccumulator

Parameters:

event - event to be added to the current batch

timer

public Timer timer()

Returns the backing timer.

Returns:

backing timer

maxEvents

public int maxEvents()

Returns the maximum number of events allowed to accumulate before processing is triggered.

Returns:

max number of events

maxBatchMillis

public int maxBatchMillis()

Returns the maximum number of millis allowed to expire since the first event before processing is triggered.

Returns:

max number of millis a batch is allowed to last

maxIdleMillis

public int maxIdleMillis()

Returns the maximum number of millis allowed to expire since the last event arrival before processing is triggered.

Returns:

max number of millis since the last event