cern.laser.util.buffer

Class LinkedQueueSynchroBuffer

java.lang.Object

cern.laser.util.buffer.LinkedQueueSynchroBuffer

public class LinkedQueueSynchroBuffer
extends java.lang.Object

A buffer class which uses an Unbounded linked list implementation with the similar function signatures to SynchroBuffer.

Author:

Niall Stapley

Constructor Summary

Constructors

Constructor and Description
LinkedQueueSynchroBuffer() The constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Close the input (head) end of the queue.
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.
java.lang.Object	take() Atempt to take an object from the end buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkedQueueSynchroBuffer

public LinkedQueueSynchroBuffer()

The constructor.

Method Detail

push

public void push(java.lang.Object object)

Push an object into the buffer.

Parameters:

o - the object to push

take

public java.lang.Object take()

Atempt to take an object from the end buffer. There is a chance this was interrupted and null is returned.

Returns:

o the object

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. In this class, it should only be called once after the listener has been set to start receiving elements.

disable

public void disable()

Disable the listener. Pushed object are kept in the buffer and delivered when the listener is enabled. In this class, this is not implemented, if starting and stopping the listener input is required, use take() instead, as this gives full control to the consumer as to when it takes an element.

close

public void close()

Close the input (head) end of the queue. It cannot be opened again. In this class, this is not implemented currently.