org.yamcs.archive

Class CcsdsTmIndex

java.lang.Object

org.yamcs.archive.CcsdsTmIndex

All Implemented Interfaces:

TmIndex, StreamSubscriber

public class CcsdsTmIndex
extends Object
implements TmIndex

Completeness index of CCSDS telemetry. There is one rocksdb table:

 key: apid[2bytes], start time[8 bytes], start seq count[2 bytes]
 value: end time[8bytes], end seq count[2 bytes], num packets [4 bytes]
 

FIXME: because the sequence count wraps around, there is a bug in case packets with the same timestamp and wrapped around sequence counts are received - see testApidIndexSameTimeAndWraparound for failing test. the old TokyoCabinet based indexer didn't use the sequence count as part of the key but allowed multiple records with the same key. To replicate this in RocksDB, one would need to have the RocksDB entries composed of all records with the same startime

Author:

nm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CcsdsTmIndex.CcsdsTmIndexRestHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
CcsdsTmIndex(String filename) Used when started standalone
CcsdsTmIndex(String instance, boolean readonly) if readonly is specified, it is open only for reading

Method Summary

Modifier and Type	Method and Description
void	addPacket(short apid, long instant, short seq)
void	close()
void	deleteRecords(long start, long stop)
IndexIterator	getIterator(List<Yamcs.NamedObjectId> names, long start, long stop) return an iterator that provides all the index entries between start and stop
static void	main(String[] args) Print the content of the index files
void	onTuple(Stream stream, Tuple tuple)
void	printApidDb()
void	printApidDb(short apid, long start, long stop)
CompletableFuture<Void>	rebuild(TimeInterval interval)
void	streamClosed(Stream stream)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

CcsdsTmIndex

public CcsdsTmIndex(String instance,
                    boolean readonly)
             throws IOException

if readonly is specified, it is open only for reading

Throws:

IOException

CcsdsTmIndex

public CcsdsTmIndex(String filename)
             throws org.rocksdb.RocksDBException

Used when started standalone

Throws:

org.rocksdb.RocksDBException

Method Detail

onTuple

public void onTuple(Stream stream,
                    Tuple tuple)

Specified by:

onTuple in interface StreamSubscriber

addPacket

public void addPacket(short apid,
                      long instant,
                      short seq)
               throws org.rocksdb.RocksDBException

Throws:

org.rocksdb.RocksDBException

close

public void close()
           throws IOException

Specified by:

close in interface TmIndex

Throws:

IOException

deleteRecords

public void deleteRecords(long start,
                          long stop)

Specified by:

deleteRecords in interface TmIndex

printApidDb

public void printApidDb()

printApidDb

public void printApidDb(short apid,
                        long start,
                        long stop)

main

public static void main(String[] args)
                 throws Exception

Print the content of the index files

Parameters:

args -

Throws:

Exception

getIterator

public IndexIterator getIterator(List<Yamcs.NamedObjectId> names,
                                 long start,
                                 long stop)

Description copied from interface: TmIndex

return an iterator that provides all the index entries between start and stop

Specified by:

getIterator in interface TmIndex

Parameters:

names - can be used to filter which entries are returned. If null, everything is returned.

Returns:

streamClosed

public void streamClosed(Stream stream)

Specified by:

streamClosed in interface StreamSubscriber

rebuild

public CompletableFuture<Void> rebuild(TimeInterval interval)
                                throws YarchException

Throws:

YarchException