Package com.beanit.dnp3bean

Class QueueEventBuffer

java.lang.Object

com.beanit.dnp3bean.QueueEventBuffer

All Implemented Interfaces:

EventBuffer

public class QueueEventBuffer
extends java.lang.Object
implements EventBuffer

An event buffer whose queues can be flexibly configured.

Use QueueEventBuffer.Builder (created using newBuilder()) to build this buffer. The buffer can be configured to contain event queues per data point, per static group, or per set of multiple static groups.

When a queue of this buffer is full any new events will be queued and cause the event at front of the queue to be removed and discarded.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueEventBuffer.Builder	Builder used to construct QueueEventBuffer

Method Summary

Modifier and Type	Method	Description
void	add(java.util.List<Event> events)	Adds the given events to the buffer.
static QueueEventBuffer.Builder	newBuilder()	Create a new builder.
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.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static QueueEventBuffer.Builder newBuilder()

Create a new builder.

Returns:

the new builder

add

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

Description copied from interface: EventBuffer

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

Specified by:

add in interface EventBuffer

Parameters:

events - the events to add

readAll

public java.util.List<Event> readAll()

Description copied from interface: EventBuffer

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.

Specified by:

readAll in interface EventBuffer

Returns:

all events stored by this buffer

readClass

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

Description copied from interface: EventBuffer

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.

Specified by:

readClass in interface EventBuffer

Parameters:

eventClass - the event class

limit - the maximum number of events to return

Returns:

the events

readGroup

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

Description copied from interface: EventBuffer

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.

Specified by:

readGroup in interface EventBuffer

Parameters:

group - the static group

limit - the maximum number of events to return

Returns:

the events

remove

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

Description copied from interface: EventBuffer

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

Specified by:

remove in interface EventBuffer

Parameters:

events - the events to remove