ej.hrt

Class LongBuffer

java.lang.Object

ej.hrt.LongBuffer

public class LongBuffer
extends java.lang.Object

HRT tasks can share data through LongBuffer instances.
A LongBuffer is a structure that contains a limited number of longs. These elements are ordered in a first-in-first-out (FIFO) manner.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DROP_OLDEST_ON_FULL_POLICY Drop oldest element when buffer is full and an element is added.
static int	SKIP_DATA_ON_FULL_POLICY When buffer is full, no element can be added.

Constructor Summary

Constructors

Constructor and Description
LongBuffer(Monitor lock, int size, int policy) Constructs a LongBuffer initialized with a buffer of size elements.

Method Summary

Modifier and Type	Method and Description
boolean	add(long l) Add an element in this buffer.
int	available() Returns the number of longs that are stored in this buffer. This method may be used before calling remove() to know if buffer is empty or not.
long	remove() Remove the oldest element from this buffer and returns it. This method is not blocking.

Methods inherited from class java.lang.Object

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

Field Detail

DROP_OLDEST_ON_FULL_POLICY

public static final int DROP_OLDEST_ON_FULL_POLICY

Drop oldest element when buffer is full and an element is added.

See Also:

Constant Field Values

SKIP_DATA_ON_FULL_POLICY

public static final int SKIP_DATA_ON_FULL_POLICY

When buffer is full, no element can be added.

See Also:

Constant Field Values

Constructor Detail

LongBuffer

public LongBuffer(Monitor lock,
                  int size,
                  int policy)

Constructs a LongBuffer initialized with a buffer of size elements.

Parameters:

lock - monitor used to synchronize accesses to the buffer.

size - maximum number of longs that can be stored in the buffer.

policy - DROP_OLDEST_ON_FULL_POLICY or SKIP_DATA_ON_FULL_POLICY

Method Detail

add

public boolean add(long l)

Add an element in this buffer. This method is not blocking.
Behavior when this buffer is full depends on the buffer policy.

Parameters:

l - the long to add in the buffer.

Returns:

true if the buffer was not full when adding the element, otherwise returns false.

remove

public long remove()

Remove the oldest element from this buffer and returns it.
This method is not blocking.

Returns:

the oldest element of this buffer or 0 if the buffer is empty.

available

public int available()

Returns the number of longs that are stored in this buffer.
This method may be used before calling remove() to know if buffer is empty or not.

Returns:

the number of longs that are stored in this buffer.