Module org.yamcs.core
Package org.yamcs.archive

Interface IndexRequestListener

public interface IndexRequestListener
Used by IndexRequestProcessor

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    IndexRequestListener.IndexType
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    begin(IndexRequestListener.IndexType type, String tblName)
    Called at the beginning or when the table/type changes in case multiple indices are sent.
    void
    finished(String token, boolean success)
    Called right after the processing ended, either successfully or through error.
    void
    processData(org.yamcs.protobuf.Yamcs.ArchiveRecord ar)
    Called with new data

  • Method Details

    • begin

      default void begin(IndexRequestListener.IndexType type, String tblName)
      Called at the beginning or when the table/type changes in case multiple indices are sent. If only one type of index is requested, it can be ignored

    • processData

      void processData(org.yamcs.protobuf.Yamcs.ArchiveRecord ar)
      Called with new data
      Parameters:
      ar -

    • finished

      void finished(String token, boolean success)
      Called right after the processing ended, either successfully or through error. If a paged request has been performed, the token can be used to retrieve the next chunk