cern.laser.util.buffer

Class SynchroBuffer

java.lang.Object

cern.laser.util.buffer.SynchroBuffer

public class SynchroBuffer
extends java.lang.Object

A buffering utility class.

Author:

F.Calderini

Field Summary

Fields

Modifier and Type	Field and Description
static int	DUPLICATE_DISCARD Discards duplicated objects.
static int	DUPLICATE_OK Allows object duplication.
static int	DUPLICATE_REPLACE Replaces duplicated objects.

Constructor Summary

Constructors

Constructor and Description
SynchroBuffer() Default constructor.
SynchroBuffer(long minWindowSize, long maxWindowSize, int windowGrowthFactor, int duplicatePolicy) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Close the buffer and deallocate resources.
void	disable() Disable the listener.
void	enable() Enable the listener.
void	push(java.util.Collection collection) Push a collection of objects into the buffer.
void	push(java.lang.Object object) Push an object into the buffer.
void	setSynchroBufferListener(SynchroBufferListener listener) Set the buffer consumer listener.

Methods inherited from class java.lang.Object

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

Field Detail

DUPLICATE_OK

public static final int DUPLICATE_OK

Allows object duplication.

See Also:

Constant Field Values

DUPLICATE_REPLACE

public static final int DUPLICATE_REPLACE

Replaces duplicated objects.

See Also:

Constant Field Values

DUPLICATE_DISCARD

public static final int DUPLICATE_DISCARD

Discards duplicated objects.

See Also:

Constant Field Values

Constructor Detail

SynchroBuffer

public SynchroBuffer(long minWindowSize,
                     long maxWindowSize,
                     int windowGrowthFactor,
                     int duplicatePolicy)

Constructor.

Parameters:

minWindowSize - the buffer window min size (msec)

maxWindowSize - the buffer window max size (msec)

windowGrowthFactor - the buffer window growth factor (size = minWindowSize + msg/sec x windowGrowthFactor)

duplicatePolicy - the buffer object duplication policy

SynchroBuffer

public SynchroBuffer()

Default constructor. Initialisation is made via properties. It reads the configuration from the resource config file specified via the system property syncrobuffer.properties. If not defined, it looks for the default config file synchrobuffer-config.properties. System properties override the configuration loaded from the properties file. Configuration properties are :

• synchrobuffer.minwindowsize
(msec, default 500)
• synchrobuffer.maxwindowsize
(msec, default 5000)
• synchrobuffer.windowgrowthfactor
(windowSize = minWindowSize + msg/sec x windowGrowthFactor, default 100)
• synchrobuffer.duplicatepolicy
(default SynchroBuffer.DUPLICATES_OK)

Method Detail

push

public void push(java.lang.Object object)

Push an object into the buffer. If the duplicate policy is DUPLICATE_DISCARD the object is discarded if the buffer already contains it. If the duplicate policy is DUPLICATE_REPLACE the object replaces any previously pushed duplicated instance. The object is appended otherwise. Equals method is used to determine duplications.

Parameters:

o - the object to push

push

public void push(java.util.Collection collection)

Push a collection of objects into the buffer.

Parameters:

collection - the collection of objects to push

setSynchroBufferListener

public void setSynchroBufferListener(SynchroBufferListener listener)

Set the buffer consumer listener.

Parameters:

listener - the listener

enable

public void enable()

Enable the listener. The listener is disabled by default.

disable

public void disable()

Disable the listener. Pushed object are kept in the buffer and delivered when the listener is enabled.

close

public void close()

Close the buffer and deallocate resources.