Class OverWritingBuffer
- All Implemented Interfaces:
Serializable
,Cloneable
,ChannelDataStore
Description
It is an implementation of ChannelDataStore that yields a FIFO buffered semantics for a channel. When empty, the channel blocks readers. When full, a writer will overwrite the latest item written to the channel. See the static construction methods ofChannel
(Channel.one2one(org.jcsp.util.ChannelDataStore)
etc.).
The getState method returns EMPTY or NONEMPTYFULL, but never FULL.
- Author:
- P.D. Austin
- See Also:
-
Field Summary
Fields inherited from interface org.jcsp.util.ChannelDataStore
EMPTY, FULL, NONEMPTYFULL
-
Constructor Summary
ConstructorsConstructorDescriptionOverWritingBuffer
(int size) Construct a new OverWritingBuffer with the specified size. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a new (and EMPTY) OverWritingBuffer with the same creation parameters as this one.void
endGet()
This ends an extended rendezvous by the reader.get()
Returns the oldest Object from the OverWritingBuffer and removes it.int
getState()
Returns the current state of the OverWritingBuffer.void
Puts a new Object into the OverWritingBuffer.void
Deletes all items in the buffer, leaving it empty.startGet()
This begins an extended rendezvous by the reader.
-
Constructor Details
-
OverWritingBuffer
public OverWritingBuffer(int size) Construct a new OverWritingBuffer with the specified size.- Parameters:
size
- the number of Objects the OverWritingBuffer can store.- Throws:
BufferSizeError
- if size is zero or negative. Note: no action should be taken to try/catch this exception - application code generating it is in error and needs correcting.
-
-
Method Details
-
get
Returns the oldest Object from the OverWritingBuffer and removes it.Pre-condition: getState must not currently return EMPTY.
- Specified by:
get
in interfaceChannelDataStore
- Returns:
- the oldest Object from the OverWritingBuffer
-
put
Puts a new Object into the OverWritingBuffer.If OverWritingBuffer is full, the last item previously put into the buffer will be overwritten.
- Specified by:
put
in interfaceChannelDataStore
- Parameters:
value
- the Object to put into the OverWritingBuffer
-
startGet
This begins an extended rendezvous by the reader. The semantics of an extended rendezvous on an overwrite-newest buffer are slightly complicated, but hopefully intuitive.If the buffer is of size 2 or larger, the semantics are as follows. Beginning an extended rendezvous will return the oldest value in the buffer, but not remove it. If the writer writes to the buffer during the rendezvous, it will grow the buffer and end up overwriting the newest value as normal. At the end of the extended rendezvous, the oldest value is removed.
If the buffer is of size 1, the semantics are identical to those of an
OverWriteOldestBuffer
. For a complete description, refer to the documentation for theOverWriteOldestBuffer.startGet()
method.- Specified by:
startGet
in interfaceChannelDataStore
- Returns:
- The oldest value in the buffer at this time
- See Also:
-
endGet
public void endGet()This ends an extended rendezvous by the reader.- Specified by:
endGet
in interfaceChannelDataStore
- See Also:
-
getState
public int getState()Returns the current state of the OverWritingBuffer.- Specified by:
getState
in interfaceChannelDataStore
- Returns:
- the current state of the OverWritingBuffer (EMPTY or NONEMPTYFULL)
-
clone
Returns a new (and EMPTY) OverWritingBuffer with the same creation parameters as this one.Note: Only the size and structure of the OverWritingBuffer is cloned, not any stored data.
- Specified by:
clone
in interfaceChannelDataStore
- Overrides:
clone
in classObject
- Returns:
- the cloned instance of this OverWritingBuffer.
-
removeAll
public void removeAll()Description copied from interface:ChannelDataStore
Deletes all items in the buffer, leaving it empty.- Specified by:
removeAll
in interfaceChannelDataStore
-