net.sf.jrtps.udds

Interface HistoryCache<T>

public interface HistoryCache<T>

HistoryCache represents a uDDS history cache.

Author:

mcr70

Method Summary

Modifier and Type	Method and Description
void	close() Close this HistoryCache.
void	coherentChangesBegin() Calling this method starts a new coherent set.
void	coherentChangesEnd() Calling this method ends current coherent set.
void	dispose(T sample, long timestamp) Dispose an instance represented by given sample
Instance<T>	getInstance(KeyHash key) Get an Instance represented by given Key
Set<Instance<T>>	getInstances() Gets instances of this HistoryCache.
LinkedList<Sample<T>>	getSamplesSince(long seqNum) Gets all the CacheChanges since given sequence number.
Instance<T>	register(T sample, long timestamp) Registers an instance represented by given sample.
void	unregister(T sample, long timestamp) Unregister an instance represented by given sample.
void	write(T sample, long timestamp) Writes a Sample.

Method Detail

coherentChangesBegin

void coherentChangesBegin()

Calling this method starts a new coherent set.

coherentChangesEnd

void coherentChangesEnd()

Calling this method ends current coherent set.

dispose

void dispose(T sample,
             long timestamp)

Dispose an instance represented by given sample

Parameters:

sample - Sample to dispose

timestamp - timestamp of the disposal

unregister

void unregister(T sample,
                long timestamp)

Unregister an instance represented by given sample.

Parameters:

sample - Sample representing instance to unregister

timestamp - timestamp of unregister

write

void write(T sample,
           long timestamp)

Writes a Sample.

Parameters:

sample - Sample to write

timestamp - timestamp of the write

register

Instance<T> register(T sample,
                     long timestamp)

Registers an instance represented by given sample.

Parameters:

sample - Sample of type T

timestamp - timestamp

Returns:

an Instance

getInstances

Set<Instance<T>> getInstances()

Gets instances of this HistoryCache.

Returns:

a Set of instances

getInstance

Instance<T> getInstance(KeyHash key)

Get an Instance represented by given Key

Parameters:

key - KeyHash representing an instance

Returns:

Instance, or null if there was not Instance with given key

getSamplesSince

LinkedList<Sample<T>> getSamplesSince(long seqNum)

Gets all the CacheChanges since given sequence number. Returned CacheChanges are ordered by sequence numbers.

Parameters:

seqNum - sequence number to compare

Returns:

changes since given seqNum. Returned List is newly allocated.

close

void close()

Close this HistoryCache.