Package com.beanit.dnp3bean

Interface EventBuffer

All Known Implementing Classes:

QueueEventBuffer

public interface EventBuffer

The interface that custom event buffers have to implement.

The reference implementation of this interface is QueueEventBuffer.

Method Summary

Modifier and Type	Method	Description
void	add(java.util.List<Event> events)	Adds the given events to the buffer.
java.util.List<Event>	readAll()	Returns all events stored by this buffer.
java.util.List<Event>	readClass(EventClass eventClass, int limit)	Returns events of the given class.
java.util.List<Event>	readGroup(StaticGroup group, int limit)	Returns events belonging to the given static group.
void	remove(java.util.List<Event> events)	Removes the given list of events from the buffer.

Method Detail

add

void add(java.util.List<Event> events)

Adds the given events to the buffer. Is called by the outstation when new events were generated.

Parameters:

events - the events to add

remove

void remove(java.util.List<Event> events)

Removes the given list of events from the buffer. Is called by the outstation when events it sent have been confirmed by the master.

Parameters:

events - the events to remove

readAll

java.util.List<Event> readAll()

Returns all events stored by this buffer. These are not yet deleted by the buffer because the first have to be confirmed by the master.

Returns:

all events stored by this buffer

readClass

java.util.List<Event> readClass(EventClass eventClass,
                                int limit)

Returns events of the given class. The maximum number of events returned is equal to the given limit. If limit is <= 0, all events of the given class are returned.

Parameters:

eventClass - the event class

limit - the maximum number of events to return

Returns:

the events

readGroup

java.util.List<Event> readGroup(StaticGroup group,
                                int limit)

Returns events belonging to the given static group. The maximum number of events returned is equal to the given * limit. If limit is <= 0, all events of the given class are returned.

Parameters:

group - the static group

limit - the maximum number of events to return

Returns:

the events